openapi: 3.0.4
info:
title: Identity.Governance
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
/agreements:
get:
tags:
- agreements.agreement
summary: Get entities from agreements
operationId: agreement_ListAgreement
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.agreementCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- agreements.agreement
summary: Add new entity to agreements
operationId: agreement_CreateAgreement
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}':
get:
tags:
- agreements.agreement
summary: Get entity from agreements by key
operationId: agreement_GetAgreement
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: $select
in: query
description: Select properties to be returned
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.agreement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreement
summary: Update entity in agreements
operationId: agreement_UpdateAgreement
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreement
summary: Delete entity from agreements
operationId: agreement_DeleteAgreement
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/acceptances':
get:
tags:
- agreements.agreementAcceptance
summary: Get acceptances from agreements
description: Read-only. Information about acceptances of this agreement.
operationId: agreement_ListAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $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.agreementAcceptanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- agreements.agreementAcceptance
summary: Create new navigation property to acceptances for agreements
operationId: agreement_CreateAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}':
get:
tags:
- agreements.agreementAcceptance
summary: Get acceptances from agreements
description: Read-only. Information about acceptances of this agreement.
operationId: agreement_GetAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreementAcceptance
summary: Update the navigation property acceptances in agreements
operationId: agreement_UpdateAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreementAcceptance
summary: Delete navigation property acceptances for agreements
operationId: agreement_DeleteAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/acceptances/$count':
get:
tags:
- agreements.agreementAcceptance
summary: Get the number of the resource
operationId: agreement.acceptance_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/agreements/{agreement-id}/file':
get:
tags:
- agreements.agreementFile
summary: Get agreementFile
description: 'Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreementfile-get?view=graph-rest-1.0
operationId: agreement_GetFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreementFile
summary: Update the navigation property file in agreements
operationId: agreement_UpdateFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreementFile
summary: Delete navigation property file for agreements
operationId: agreement_DeleteFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/file/localizations':
get:
tags:
- agreements.agreementFile
summary: List agreementFileLocalizations
description: Get a list of the default and localized agreement files.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreementfile-list-localizations?view=graph-rest-1.0
operationId: agreement.file_ListLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $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.agreementFileLocalizationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- agreements.agreementFile
summary: Create new navigation property to localizations for agreements
operationId: agreement.file_CreateLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}':
get:
tags:
- agreements.agreementFile
summary: Get localizations from agreements
description: The localized version of the terms of use agreement files attached to the agreement.
operationId: agreement.file_GetLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreementFile
summary: Update the navigation property localizations in agreements
operationId: agreement.file_UpdateLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreementFile
summary: Delete navigation property localizations for agreements
operationId: agreement.file_DeleteLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions':
get:
tags:
- agreements.agreementFile
summary: Get versions from agreements
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: agreement.file.localization_ListVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $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.agreementFileVersionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- agreements.agreementFile
summary: Create new navigation property to versions for agreements
operationId: agreement.file.localization_CreateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}':
get:
tags:
- agreements.agreementFile
summary: Get versions from agreements
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: agreement.file.localization_GetVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreementFile
summary: Update the navigation property versions in agreements
operationId: agreement.file.localization_UpdateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreementFile
summary: Delete navigation property versions for agreements
operationId: agreement.file.localization_DeleteVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/$count':
get:
tags:
- agreements.agreementFile
summary: Get the number of the resource
operationId: agreement.file.localization.version_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/agreements/{agreement-id}/file/localizations/$count':
get:
tags:
- agreements.agreementFile
summary: Get the number of the resource
operationId: agreement.file.localization_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/agreements/{agreement-id}/files':
get:
tags:
- agreements.agreementFileLocalization
summary: Get files from agreements
description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
operationId: agreement_ListFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $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.agreementFileLocalizationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- agreements.agreementFileLocalization
summary: Create new navigation property to files for agreements
operationId: agreement_CreateFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/files/{agreementFileLocalization-id}':
get:
tags:
- agreements.agreementFileLocalization
summary: Get files from agreements
description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
operationId: agreement_GetFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreementFileLocalization
summary: Update the navigation property files in agreements
operationId: agreement_UpdateFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreementFileLocalization
summary: Delete navigation property files for agreements
operationId: agreement_DeleteFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions':
get:
tags:
- agreements.agreementFileLocalization
summary: Get versions from agreements
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: agreement.file_ListVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $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.agreementFileVersionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- agreements.agreementFileLocalization
summary: Create new navigation property to versions for agreements
operationId: agreement.file_CreateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}':
get:
tags:
- agreements.agreementFileLocalization
summary: Get versions from agreements
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: agreement.file_GetVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- agreements.agreementFileLocalization
summary: Update the navigation property versions in agreements
operationId: agreement.file_UpdateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- agreements.agreementFileLocalization
summary: Delete navigation property versions for agreements
operationId: agreement.file_DeleteVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/$count':
get:
tags:
- agreements.agreementFileLocalization
summary: Get the number of the resource
operationId: agreement.file.version_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/agreements/{agreement-id}/files/$count':
get:
tags:
- agreements.agreementFileLocalization
summary: Get the number of the resource
operationId: agreement.file_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance:
get:
tags:
- identityGovernance.identityGovernance
summary: Get identityGovernance
operationId: identityGovernance_GetIdentityGovernance
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.identityGovernance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.identityGovernance
summary: Update identityGovernance
operationId: identityGovernance_UpdateIdentityGovernance
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/accessReviews:
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviews from identityGovernance
operationId: identityGovernance_GetAccessReview
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property accessReviews in identityGovernance
operationId: identityGovernance_UpdateAccessReview
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewSet'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property accessReviews for identityGovernance
operationId: identityGovernance_DeleteAccessReview
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/accessReviews/definitions:
get:
tags:
- identityGovernance.accessReviewSet
summary: List definitions
description: Get a list of the accessReviewScheduleDefinition objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewset-list-definitions?view=graph-rest-1.0
operationId: identityGovernance.accessReview_ListDefinition
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.accessReviewScheduleDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create definitions
description: Create a new accessReviewScheduleDefinition object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewset-post-definitions?view=graph-rest-1.0
operationId: identityGovernance.accessReview_CreateDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviewScheduleDefinition
description: 'Read the properties and relationships of an accessReviewScheduleDefinition object. To retrieve the instances of the access review series, use the list accessReviewInstance API.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewscheduledefinition-get?view=graph-rest-1.0
operationId: identityGovernance.accessReview_GetDefinition
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- identityGovernance.accessReviewSet
summary: Update accessReviewScheduleDefinition
description: Update an existing accessReviewScheduleDefinition object to change one or more of its properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewscheduledefinition-update?view=graph-rest-1.0
operationId: identityGovernance.accessReview_SetDefinition
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete accessReviewScheduleDefinition
description: Deletes an accessReviewScheduleDefinition object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewscheduledefinition-delete?view=graph-rest-1.0
operationId: identityGovernance.accessReview_DeleteDefinition
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances':
get:
tags:
- identityGovernance.accessReviewSet
summary: List instances
description: Get a list of the accessReviewInstance objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewscheduledefinition-list-instances?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition_ListInstance
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- $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.accessReviewInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to instances for identityGovernance
operationId: identityGovernance.accessReview.definition_CreateInstance
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviewInstance
description: Read the properties and relationships of an accessReviewInstance object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-get?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition_GetInstance
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update accessReviewInstance
description: 'Update the properties of an accessReviewInstance object. Only the reviewers and fallbackReviewers properties can be updated but the scope property is also required in the request body. You can only add reviewers to the fallbackReviewers property but can''t remove existing fallbackReviewers. To update an accessReviewInstance, it''s status must be InProgress.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-update?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition_UpdateInstance
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property instances for identityGovernance
operationId: identityGovernance.accessReview.definition_DeleteInstance
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/contactedReviewers':
get:
tags:
- identityGovernance.accessReviewSet
summary: List contactedReviewers
description: 'Get the reviewers for an access review instance, irrespective of whether or not they have received a notification. The reviewers are represented by an accessReviewReviewer object. A list of zero or more objects are returned, including all of their nested properties.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-list-contactedreviewers?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_ListContactedReviewer
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- $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.accessReviewReviewerCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to contactedReviewers for identityGovernance
operationId: identityGovernance.accessReview.definition.instance_CreateContactedReviewer
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/contactedReviewers/{accessReviewReviewer-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get contactedReviewers from identityGovernance
description: 'Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.'
operationId: identityGovernance.accessReview.definition.instance_GetContactedReviewer
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewReviewer-id
in: path
description: The unique identifier of accessReviewReviewer
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewReviewer
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property contactedReviewers in identityGovernance
operationId: identityGovernance.accessReview.definition.instance_UpdateContactedReviewer
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewReviewer-id
in: path
description: The unique identifier of accessReviewReviewer
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewReviewer
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property contactedReviewers for identityGovernance
operationId: identityGovernance.accessReview.definition.instance_DeleteContactedReviewer
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewReviewer-id
in: path
description: The unique identifier of accessReviewReviewer
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewReviewer
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/contactedReviewers/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance.contactedReviewer_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions':
get:
tags:
- identityGovernance.accessReviewSet
summary: List decisions
description: 'Retrieve the accessReviewInstanceDecisionItem objects for a specific accessReviewInstance. A list of zero or more accessReviewInstanceDecisionItem objects are returned, including all of their nested properties.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-list-decisions?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_ListDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- $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.accessReviewInstanceDecisionItemCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to decisions for identityGovernance
operationId: identityGovernance.accessReview.definition.instance_CreateDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions/{accessReviewInstanceDecisionItem-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviewInstanceDecisionItem
description: Read the properties and relationships of an accessReviewInstanceDecisionItem object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstancedecisionitem-get?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_GetDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property decisions in identityGovernance
operationId: identityGovernance.accessReview.definition.instance_UpdateDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property decisions for identityGovernance
operationId: identityGovernance.accessReview.definition.instance_DeleteDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions/{accessReviewInstanceDecisionItem-id}/insights':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get insights from identityGovernance
description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
operationId: identityGovernance.accessReview.definition.instance.decision_ListInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- $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.governanceInsightCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to insights for identityGovernance
operationId: identityGovernance.accessReview.definition.instance.decision_CreateInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions/{accessReviewInstanceDecisionItem-id}/insights/{governanceInsight-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get insights from identityGovernance
description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
operationId: identityGovernance.accessReview.definition.instance.decision_GetInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: governanceInsight-id
in: path
description: The unique identifier of governanceInsight
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: governanceInsight
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property insights in identityGovernance
operationId: identityGovernance.accessReview.definition.instance.decision_UpdateInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: governanceInsight-id
in: path
description: The unique identifier of governanceInsight
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: governanceInsight
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property insights for identityGovernance
operationId: identityGovernance.accessReview.definition.instance.decision_DeleteInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: governanceInsight-id
in: path
description: The unique identifier of governanceInsight
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: governanceInsight
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions/{accessReviewInstanceDecisionItem-id}/insights/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance.decision.insight_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance.decision_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/decisions/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.accessReviewSet
summary: Invoke function filterByCurrentUser
description: Retrieve all decision items for an instance of an access review or a stage of an instance of a multi-stage access review for which the calling user is the reviewer. The decision items are presented as accessReviewInstanceDecisionItem objects on a given accessReviewInstance or accessReviewStage for which the calling user is the reviewer.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstancedecisionitem-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.decision_filterGraphBPreCurrentUser
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessReviewInstanceDecisionItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/microsoft.graph.acceptRecommendations':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action acceptRecommendations
description: Allows the acceptance of recommendations on all accessReviewInstanceDecisionItem objects that haven't been reviewed on an accessReviewInstance object for which the calling user is a reviewer.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-acceptrecommendations?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_acceptRecommendation
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/microsoft.graph.applyDecisions':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action applyDecisions
description: Apply review decisions on an accessReviewInstance if the decisions were not applied automatically because the autoApplyDecisionsEnabled property is false in the review's accessReviewScheduleSettings. The status of the accessReviewInstance must be Completed to call this method.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-applydecisions?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_applyDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/microsoft.graph.batchRecordDecisions':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action batchRecordDecisions
description: 'Enables reviewers to review all accessReviewInstanceDecisionItem objects in a specific accessReviewInstance in batches by using principalId, resourceId, or neither.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-batchrecorddecisions?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_batchRecordDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
decision:
type: string
nullable: true
justification:
type: string
nullable: true
principalId:
type: string
nullable: true
resourceId:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/microsoft.graph.resetDecisions':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action resetDecisions
description: Resets all accessReviewInstanceDecisionItem objects on an accessReviewInstance to notReviewed.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-resetdecisions?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_resetDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/microsoft.graph.sendReminder':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action sendReminder
description: Send a reminder to the reviewers of an active accessReviewInstance.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-sendreminder?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_sendReminder
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/microsoft.graph.stop':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action stop
description: 'Stop a currently active accessReviewInstance. After the access review instance stops, the instance status is marked as Completed, the reviewers can no longer give input, and the access review decisions are applied. Stopping an instance will not stop future instances. To prevent a recurring access review from starting future instances, update the schedule definition to change its scheduled end date.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-stop?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_stop
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages':
get:
tags:
- identityGovernance.accessReviewSet
summary: List stages (of an access review)
description: Retrieve the accessReviewStage objects for a specific accessReviewInstance in a multi-stage access review.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-list-stages?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_ListStage
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- $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.accessReviewStageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to stages for identityGovernance
operationId: identityGovernance.accessReview.definition.instance_CreateStage
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviewStage
description: Retrieve the properties and relationships of an accessReviewStage object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewstage-get?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_GetStage
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update accessReviewStage
description: 'Update the properties of an accessReviewStage object. Only the reviewers and fallbackReviewers properties can be updated. You can only add reviewers to the fallbackReviewers property but can''t remove existing fallbackReviewers. To update an accessReviewStage, its status must be NotStarted, Initializing, or InProgress.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewstage-update?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_UpdateStage
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property stages for identityGovernance
operationId: identityGovernance.accessReview.definition.instance_DeleteStage
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions':
get:
tags:
- identityGovernance.accessReviewSet
summary: List decisions (from a multi-stage access review)
description: Get the accessReviewInstanceDecisionItem objects from an accessReviewStage in a multi-stage access review.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewstage-list-decisions?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.stage_ListDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- $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.accessReviewInstanceDecisionItemCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to decisions for identityGovernance
operationId: identityGovernance.accessReview.definition.instance.stage_CreateDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions/{accessReviewInstanceDecisionItem-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviewInstanceDecisionItem
description: Read the properties and relationships of an accessReviewInstanceDecisionItem object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstancedecisionitem-get?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.stage_GetDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update accessReviewInstanceDecisionItem
description: 'Update access decisions, known as accessReviewInstanceDecisionItems, for which the user is the reviewer.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstancedecisionitem-update?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.stage_UpdateDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property decisions for identityGovernance
operationId: identityGovernance.accessReview.definition.instance.stage_DeleteDecision
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions/{accessReviewInstanceDecisionItem-id}/insights':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get insights from identityGovernance
description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
operationId: identityGovernance.accessReview.definition.instance.stage.decision_ListInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- $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.governanceInsightCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to insights for identityGovernance
operationId: identityGovernance.accessReview.definition.instance.stage.decision_CreateInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions/{accessReviewInstanceDecisionItem-id}/insights/{governanceInsight-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get insights from identityGovernance
description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
operationId: identityGovernance.accessReview.definition.instance.stage.decision_GetInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: governanceInsight-id
in: path
description: The unique identifier of governanceInsight
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: governanceInsight
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property insights in identityGovernance
operationId: identityGovernance.accessReview.definition.instance.stage.decision_UpdateInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: governanceInsight-id
in: path
description: The unique identifier of governanceInsight
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: governanceInsight
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property insights for identityGovernance
operationId: identityGovernance.accessReview.definition.instance.stage.decision_DeleteInsight
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- name: governanceInsight-id
in: path
description: The unique identifier of governanceInsight
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: governanceInsight
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions/{accessReviewInstanceDecisionItem-id}/insights/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance.stage.decision.insight_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: accessReviewInstanceDecisionItem-id
in: path
description: The unique identifier of accessReviewInstanceDecisionItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstanceDecisionItem
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance.stage.decision_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/decisions/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.accessReviewSet
summary: Invoke function filterByCurrentUser
description: Retrieve all decision items for an instance of an access review or a stage of an instance of a multi-stage access review for which the calling user is the reviewer. The decision items are presented as accessReviewInstanceDecisionItem objects on a given accessReviewInstance or accessReviewStage for which the calling user is the reviewer.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstancedecisionitem-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.stage.decision_filterGraphBPreCurrentUser
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessReviewInstanceDecisionItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/{accessReviewStage-id}/microsoft.graph.stop':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action stop
description: 'Stop an access review stage that is inProgress. After the access review stage stops, the stage status will be Completed and the reviewers can no longer give input. If there are subsequent stages that depend on the completed stage, the next stage will be created. The accessReviewInstanceDecisionItem objects will always reflect the last decisions recorded across all stages at that given time, regardless of the status of the stages.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewstage-stop?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.stage_stop
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: accessReviewStage-id
in: path
description: The unique identifier of accessReviewStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewStage
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance.stage_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/{accessReviewInstance-id}/stages/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.accessReviewSet
summary: Invoke function filterByCurrentUser
description: Return all accessReviewStage objects on a given accessReviewInstance where the calling user is a reviewer on one or more accessReviewInstanceDecisionItem objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewstage-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance.stage_filterGraphBPreCurrentUser
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: accessReviewInstance-id
in: path
description: The unique identifier of accessReviewInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewInstance
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStageFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessReviewStage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition.instance_GetCount
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/instances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.accessReviewSet
summary: Invoke function filterByCurrentUser
description: Retrieve all accessReviewInstance objects on a given accessReviewScheduleDefinition where the calling user is a reviewer on one or more accessReviewInstanceDecisionItem objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition.instance_filterGraphBPreCurrentUser
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessReviewInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinition-id}/microsoft.graph.stop':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action stop
operationId: identityGovernance.accessReview.definition_stop
parameters:
- name: accessReviewScheduleDefinition-id
in: path
description: The unique identifier of accessReviewScheduleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewScheduleDefinition
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identityGovernance/accessReviews/definitions/$count:
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.definition_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/accessReviews/definitions/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.accessReviewSet
summary: Invoke function filterByCurrentUser
description: Returns accessReviewScheduleDefinition objects where the calling user is a reviewer on one or more accessReviewInstance objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewscheduledefinition-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.accessReview.definition_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinitionFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessReviewScheduleDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/accessReviews/historyDefinitions:
get:
tags:
- identityGovernance.accessReviewSet
summary: List historyDefinitions
description: 'Retrieve the accessReviewHistoryDefinition objects created in the last 30 days, including all nested properties.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewset-list-historydefinitions?view=graph-rest-1.0
operationId: identityGovernance.accessReview_ListHistoryDefinition
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.accessReviewHistoryDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create historyDefinitions
description: Create a new accessReviewHistoryDefinition object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewset-post-historydefinitions?view=graph-rest-1.0
operationId: identityGovernance.accessReview_CreateHistoryDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/historyDefinitions/{accessReviewHistoryDefinition-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get accessReviewHistoryDefinition
description: 'Retrieve an accessReviewHistoryDefinition object by its identifier. All the properties of the access review history definition object are returned. If the definition is 30 days or older, a 404 Not Found error is returned.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewhistorydefinition-get?view=graph-rest-1.0
operationId: identityGovernance.accessReview_GetHistoryDefinition
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property historyDefinitions in identityGovernance
operationId: identityGovernance.accessReview_UpdateHistoryDefinition
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property historyDefinitions for identityGovernance
operationId: identityGovernance.accessReview_DeleteHistoryDefinition
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/historyDefinitions/{accessReviewHistoryDefinition-id}/instances':
get:
tags:
- identityGovernance.accessReviewSet
summary: List instances (of an accessReviewHistoryDefinition)
description: Retrieve the instances of an access review history definition created in the last 30 days.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewhistorydefinition-list-instances?view=graph-rest-1.0
operationId: identityGovernance.accessReview.historyDefinition_ListInstance
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- $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.accessReviewHistoryInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create new navigation property to instances for identityGovernance
operationId: identityGovernance.accessReview.historyDefinition_CreateInstance
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/historyDefinitions/{accessReviewHistoryDefinition-id}/instances/{accessReviewHistoryInstance-id}':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get instances from identityGovernance
description: 'If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn''t recur will have exactly one instance.'
operationId: identityGovernance.accessReview.historyDefinition_GetInstance
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- name: accessReviewHistoryInstance-id
in: path
description: The unique identifier of accessReviewHistoryInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessReviewSet
summary: Update the navigation property instances in identityGovernance
operationId: identityGovernance.accessReview.historyDefinition_UpdateInstance
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- name: accessReviewHistoryInstance-id
in: path
description: The unique identifier of accessReviewHistoryInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessReviewSet
summary: Delete navigation property instances for identityGovernance
operationId: identityGovernance.accessReview.historyDefinition_DeleteInstance
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- name: accessReviewHistoryInstance-id
in: path
description: The unique identifier of accessReviewHistoryInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/accessReviews/historyDefinitions/{accessReviewHistoryDefinition-id}/instances/{accessReviewHistoryInstance-id}/microsoft.graph.generateDownloadUri':
post:
tags:
- identityGovernance.accessReviewSet
summary: Invoke action generateDownloadUri
description: Generates a URI for an accessReviewHistoryInstance object the status for which is done. Each URI can be used to retrieve the instance's review history data. Each URI is valid for 24 hours and can be retrieved by fetching the downloadUri property from the accessReviewHistoryInstance object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accessreviewhistoryinstance-generatedownloaduri?view=graph-rest-1.0
operationId: identityGovernance.accessReview.historyDefinition.instance_generateDownloadUri
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- name: accessReviewHistoryInstance-id
in: path
description: The unique identifier of accessReviewHistoryInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryInstance
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/accessReviews/historyDefinitions/{accessReviewHistoryDefinition-id}/instances/$count':
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.historyDefinition.instance_GetCount
parameters:
- name: accessReviewHistoryDefinition-id
in: path
description: The unique identifier of accessReviewHistoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessReviewHistoryDefinition
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/accessReviews/historyDefinitions/$count:
get:
tags:
- identityGovernance.accessReviewSet
summary: Get the number of the resource
operationId: identityGovernance.accessReview.historyDefinition_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/appConsent:
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get appConsent from identityGovernance
operationId: identityGovernance_GetAppConsent
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentApprovalRoute'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Update the navigation property appConsent in identityGovernance
operationId: identityGovernance_UpdateAppConsent
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentApprovalRoute'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentApprovalRoute'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Delete navigation property appConsent for identityGovernance
operationId: identityGovernance_DeleteAppConsent
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/appConsent/appConsentRequests:
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: List appConsentRequests
description: Retrieve appConsentRequest objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appconsentapprovalroute-list-appconsentrequests?view=graph-rest-1.0
operationId: identityGovernance.appConsent_ListAppConsentRequest
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.appConsentRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Create new navigation property to appConsentRequests for identityGovernance
operationId: identityGovernance.appConsent_CreateAppConsentRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get appConsentRequest
description: Read the properties and relationships of an appConsentRequest object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appconsentrequest-get?view=graph-rest-1.0
operationId: identityGovernance.appConsent_GetAppConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Update the navigation property appConsentRequests in identityGovernance
operationId: identityGovernance.appConsent_UpdateAppConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Delete navigation property appConsentRequests for identityGovernance
operationId: identityGovernance.appConsent_DeleteAppConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: List userConsentRequests
description: Retrieve a collection of userConsentRequest objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appconsentrequest-list-userconsentrequests?view=graph-rest-1.0
operationId: identityGovernance.appConsent.appConsentRequest_ListUserConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- $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.userConsentRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Create new navigation property to userConsentRequests for identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest_CreateUserConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/{userConsentRequest-id}':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get userConsentRequest
description: Read the properties and relationships of a userConsentRequest object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userconsentrequest-get?view=graph-rest-1.0
operationId: identityGovernance.appConsent.appConsentRequest_GetUserConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Update the navigation property userConsentRequests in identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest_UpdateUserConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Delete navigation property userConsentRequests for identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest_DeleteUserConsentRequest
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/{userConsentRequest-id}/approval':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get approval from identityGovernance
description: Approval decisions associated with a request.
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest_GetApproval
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Update the navigation property approval in identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest_UpdateApproval
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Delete navigation property approval for identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest_DeleteApproval
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/{userConsentRequest-id}/approval/stages':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get stages from identityGovernance
description: A collection of stages in the approval decision.
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest.approval_ListStage
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- $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.approvalStageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Create new navigation property to stages for identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest.approval_CreateStage
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/{userConsentRequest-id}/approval/stages/{approvalStage-id}':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get stages from identityGovernance
description: A collection of stages in the approval decision.
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest.approval_GetStage
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Update the navigation property stages in identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest.approval_UpdateStage
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Delete navigation property stages for identityGovernance
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest.approval_DeleteStage
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/{userConsentRequest-id}/approval/stages/$count':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get the number of the resource
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest.approval.stage_GetCount
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: userConsentRequest-id
in: path
description: The unique identifier of userConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userConsentRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/$count':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get the number of the resource
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest_GetCount
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/appConsent/appConsentRequests/{appConsentRequest-id}/userConsentRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Invoke function filterByCurrentUser
description: 'Retrieve a collection of userConsentRequest objects for accessing a specified app, for which the current user is the reviewer.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userconsentrequest-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.appConsent.appConsentRequest.userConsentRequest_filterGraphBPreCurrentUser
parameters:
- name: appConsentRequest-id
in: path
description: The unique identifier of appConsentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appConsentRequest
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.consentRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of userConsentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/appConsent/appConsentRequests/$count:
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Get the number of the resource
operationId: identityGovernance.appConsent.appConsentRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/appConsent/appConsentRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.appConsentApprovalRoute
summary: Invoke function filterByCurrentUser
description: Retrieve a collection of appConsentRequest objects for which the current user is the reviewer and the status of the userConsentRequest for accessing the specified app is InProgress.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appconsentrequest-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.appConsent.appConsentRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.consentRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of appConsentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/catalogs:
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get catalogs from identityGovernance
operationId: identityGovernance_ListCatalog
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.accessPackageCatalogCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to catalogs for identityGovernance
operationId: identityGovernance_CreateCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get catalogs from identityGovernance
operationId: identityGovernance_GetCatalog
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property catalogs in identityGovernance
operationId: identityGovernance_UpdateCatalog
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property catalogs for identityGovernance
operationId: identityGovernance_DeleteCatalog
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/accessPackages':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get accessPackages from identityGovernance
description: The access packages in this catalog. Read-only. Nullable.
operationId: identityGovernance.catalog_ListAccessPackage
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get accessPackages from identityGovernance
description: The access packages in this catalog. Read-only. Nullable.
operationId: identityGovernance.catalog_GetAccessPackage
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/accessPackages/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.accessPackage_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/customWorkflowExtensions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get customWorkflowExtensions from identityGovernance
operationId: identityGovernance.catalog_ListCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.customCalloutExtensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to customWorkflowExtensions for identityGovernance
operationId: identityGovernance.catalog_CreateCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/customWorkflowExtensions/{customCalloutExtension-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get customWorkflowExtensions from identityGovernance
operationId: identityGovernance.catalog_GetCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property customWorkflowExtensions in identityGovernance
operationId: identityGovernance.catalog_UpdateCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property customWorkflowExtensions for identityGovernance
operationId: identityGovernance.catalog_DeleteCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/customWorkflowExtensions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.customWorkflowExtension_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resourceRoles from identityGovernance
operationId: identityGovernance.catalog_ListResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to resourceRoles for identityGovernance
operationId: identityGovernance.catalog_CreateResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resourceRoles from identityGovernance
operationId: identityGovernance.catalog_GetResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resourceRoles in identityGovernance
operationId: identityGovernance.catalog_UpdateResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resourceRoles for identityGovernance
operationId: identityGovernance.catalog_DeleteResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resourceRole_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resourceRole_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resourceRole_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resourceRole.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/roles':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/roles/{accessPackageResourceRole-id1}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/roles/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id1}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceRole.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceRole.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceRole.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceRoles/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceRole_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resources from identityGovernance
description: Access package resources in this catalog.
operationId: identityGovernance.catalog_ListResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageResourceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to resources for identityGovernance
operationId: identityGovernance.catalog_CreateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resources from identityGovernance
description: Access package resources in this catalog.
operationId: identityGovernance.catalog_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resources in identityGovernance
operationId: identityGovernance.catalog_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resources for identityGovernance
operationId: identityGovernance.catalog_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.catalog.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.catalog.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.catalog.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resource.role_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resource.role_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resource.role_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resource.role.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource.role.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource.role.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.catalog.resource.role.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resource.role.resource.scope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resource.role.resource.scope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource.scope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.catalog.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.catalog.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.catalog.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resource.scope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resource.scope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resource.scope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resource.scope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource.scope.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resource.scope.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource.role_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource.role_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource.role_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resources/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resource_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resourceScopes from identityGovernance
operationId: identityGovernance.catalog_ListResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to resourceScopes for identityGovernance
operationId: identityGovernance.catalog_CreateResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resourceScopes from identityGovernance
operationId: identityGovernance.catalog_GetResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resourceScopes in identityGovernance
operationId: identityGovernance.catalog_UpdateResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resourceScopes for identityGovernance
operationId: identityGovernance.catalog_DeleteResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resourceScope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resourceScope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resourceScope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resourceScope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get resource from identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action refresh
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id1}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/scopes':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/scopes/{accessPackageResourceScope-id1}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.catalog.resourceScope.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceScope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.catalog.resourceScope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.accessPackageCatalog
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.catalog.resourceScope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.accessPackageCatalog
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.accessPackageCatalog
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.accessPackageCatalog
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/catalogs/{accessPackageCatalog-id}/resourceScopes/$count':
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog.resourceScope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/catalogs/$count:
get:
tags:
- identityGovernance.accessPackageCatalog
summary: Get the number of the resource
operationId: identityGovernance.catalog_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get entitlementManagement from identityGovernance
operationId: identityGovernance_GetEntitlementManagement
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entitlementManagement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property entitlementManagement in identityGovernance
operationId: identityGovernance_UpdateEntitlementManagement
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entitlementManagement'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entitlementManagement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property entitlementManagement for identityGovernance
operationId: identityGovernance_DeleteEntitlementManagement
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get approval
description: "Retrieve the properties of an approval object. This API request is made by an approver in the following scenarios: In Microsoft Entra entitlement management, providing the identifier of the access package assignment request.\r\nIn PIM for Groups, providing the identifier of the assignment schedule request."
operationId: identityGovernance.entitlementManagement_ListAccessPackageAssignmentApproval
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.approvalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to accessPackageAssignmentApprovals for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateAccessPackageAssignmentApproval
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{approval-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get approval
description: "Retrieve the properties of an approval object. This API request is made by an approver in the following scenarios: In Microsoft Entra entitlement management, providing the identifier of the access package assignment request.\r\nIn PIM for Groups, providing the identifier of the assignment schedule request."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approval-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetAccessPackageAssignmentApproval
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property accessPackageAssignmentApprovals in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateAccessPackageAssignmentApproval
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property accessPackageAssignmentApprovals for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteAccessPackageAssignmentApproval
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{approval-id}/stages':
get:
tags:
- identityGovernance.entitlementManagement
summary: List approval stages
description: "List the approvalStage objects associated with an approval. This API request is made by an approver in the following scenarios: In Microsoft Entra entitlement management, providing the identifier of the access package assignment request.\r\nIn PIM for Groups, providing the identifier of the assignment schedule request."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approval-list-stages?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_ListStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- $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.approvalStageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to stages for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_CreateStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{approval-id}/stages/{approvalStage-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get approvalStage
description: Retrieve the properties of an approvalStage object. An approval stage is contained within an approval object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approvalstage-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_GetStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update approvalStage
description: Approve or deny an approvalStage object in an approval.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approvalstage-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_UpdateStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property stages for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_DeleteStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/{approval-id}/stages/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval.stage_GetCount
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function filterByCurrentUser
description: 'In Microsoft Entra entitlement management, return a collection of access package assignment approvals. The objects returned are those that are in scope for approval by the calling user. In PIM for Groups, return a collection of assignment approvals. The objects returned are those that are in scope for approval by the calling user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approval-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackageAssignmentApproval_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.approvalFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of approval
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/entitlementManagement/accessPackages:
get:
tags:
- identityGovernance.entitlementManagement
summary: List accessPackages
description: 'Retrieve a list of accessPackage objects. The resulting list includes all the access packages that the caller has access to read, across all catalogs.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-accesspackages?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListAccessPackage
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.accessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create accessPackage
description: Create a new accessPackage object. The access package will be added to an existing accessPackageCatalog.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-post-accesspackages?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_CreateAccessPackage
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackage
description: Retrieve the properties and relationships of an accessPackage object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetAccessPackage
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update accessPackage
description: 'Update an existing accessPackage object to change one or more of its properties, such as the display name or description.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_UpdateAccessPackage
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete accessPackage
description: Delete an accessPackage object. You cannot delete an access package if it has any accessPackageAssignment.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-delete?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_DeleteAccessPackage
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith':
get:
tags:
- identityGovernance.entitlementManagement
summary: List accessPackagesIncompatibleWith
description: Retrieve a list of the accessPackage objects that have marked a specified accessPackage as incompatible.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-list-accesspackagesincompatiblewith?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_ListAccessPackagesIncompatibleGraphWPre
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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.accessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith/{accessPackage-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackagesIncompatibleWith from identityGovernance
description: The access packages that are incompatible with this package. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage_GetAccessPackagesIncompatibleGraphWPre
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackage-id1
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.accessPackagesIncompatibleWith_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get assignmentPolicies from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage_ListAssignmentPolicy
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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.accessPackageAssignmentPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to assignmentPolicies for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage_CreateAssignmentPolicy
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get assignmentPolicies from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage_GetAssignmentPolicy
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property assignmentPolicies in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage_UpdateAssignmentPolicy
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property assignmentPolicies for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage_DeleteAssignmentPolicy
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/accessPackage':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackage from identityGovernance
description: Access package containing this policy. Read-only. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_GetAccessPackage
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/catalog':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get catalog from identityGovernance
description: Catalog of the access package containing this policy. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_GetCatalog
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customExtensionStageSettings from identityGovernance
description: The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_ListCustomExtensionStageSetting
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $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.customExtensionStageSettingCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to customExtensionStageSettings for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_CreateCustomExtensionStageSetting
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings/{customExtensionStageSetting-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customExtensionStageSettings from identityGovernance
description: The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_GetCustomExtensionStageSetting
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property customExtensionStageSettings in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_UpdateCustomExtensionStageSetting
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property customExtensionStageSettings for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_DeleteCustomExtensionStageSetting
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings/{customExtensionStageSetting-id}/customExtension':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customExtension from identityGovernance
description: Indicates the custom workflow extension that will be executed at this stage. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy.customExtensionStageSetting_GetCustomExtension
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy.customExtensionStageSetting_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/questions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get questions from identityGovernance
description: Questions that are posed to the requestor.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_ListQuestion
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $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.accessPackageQuestionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to questions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_CreateQuestion
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/questions/{accessPackageQuestion-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get questions from identityGovernance
description: Questions that are posed to the requestor.
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_GetQuestion
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: accessPackageQuestion-id
in: path
description: The unique identifier of accessPackageQuestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageQuestion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property questions in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_UpdateQuestion
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: accessPackageQuestion-id
in: path
description: The unique identifier of accessPackageQuestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageQuestion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property questions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_DeleteQuestion
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: accessPackageQuestion-id
in: path
description: The unique identifier of accessPackageQuestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageQuestion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/questions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy.question_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.assignmentPolicy_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/catalog':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get catalog from identityGovernance
description: Required when creating the access package. Read-only. Nullable.
operationId: identityGovernance.entitlementManagement.accessPackage_GetCatalog
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages':
get:
tags:
- identityGovernance.entitlementManagement
summary: List incompatibleAccessPackages
description: 'Retrieve a list of the accessPackage objects that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-list-incompatibleaccesspackages?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_ListIncompatibleAccessPackage
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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.accessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages/{accessPackage-id1}/$ref':
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove accessPackage from incompatibleAccessPackages
description: 'Remove an access package from the list of access packages that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-delete-incompatibleaccesspackage?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage.incompatibleAccessPackage_DeleteAccessPackageGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackage-id1
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.incompatibleAccessPackage_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages/$ref':
get:
tags:
- identityGovernance.entitlementManagement
summary: List incompatibleAccessPackages
description: 'Retrieve a list of the accessPackage objects that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-list-incompatibleaccesspackages?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_ListIncompatibleAccessPackageGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Add accessPackage to incompatibleAccessPackages
description: 'Add an accessPackage to the list of access packages that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-post-incompatibleaccesspackage?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_CreateIncompatibleAccessPackageGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove accessPackage from incompatibleAccessPackages
description: 'Remove an access package from the list of access packages that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-delete-incompatibleaccesspackage?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_DeleteIncompatibleAccessPackageGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups':
get:
tags:
- identityGovernance.entitlementManagement
summary: List incompatibleGroups
description: 'Retrieve a list of the group objects that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-list-incompatiblegroups?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_ListIncompatibleGroup
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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.groupCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/{group-id}/$ref':
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove group from incompatibleGroups
description: 'Remove a group from the list of groups that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-delete-incompatiblegroup?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage.incompatibleGroup_DeleteGroupGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/{group-id}/serviceProvisioningErrors':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.entitlementManagement.accessPackage.incompatibleGroup_ListServiceProvisioningError
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/{group-id}/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.incompatibleGroup.ServiceProvisioningError_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.incompatibleGroup_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/$ref':
get:
tags:
- identityGovernance.entitlementManagement
summary: List incompatibleGroups
description: 'Retrieve a list of the group objects that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-list-incompatiblegroups?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_ListIncompatibleGroupGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Add group to incompatibleGroups
description: 'Add a group to the list of groups that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-post-incompatiblegroup?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_CreateIncompatibleGroupGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove group from incompatibleGroups
description: 'Remove a group from the list of groups that have been marked as incompatible on an accessPackage. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-delete-incompatiblegroup?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_DeleteIncompatibleGroupGraphBPreRef
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/microsoft.graph.getApplicablePolicyRequirements':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action getApplicablePolicyRequirements
description: 'In Microsoft Entra entitlement management, this action retrieves accessPackageAssignmentRequestRequirements objects for an accessPackage that the currently signed-in user can use to create an accessPackageAssignmentRequest. Each requirement object corresponds to an access package assignment policy that the currently signed-in user is allowed to request an assignment for.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-getapplicablepolicyrequirements?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_getApplicablePolicyRequirement
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestRequirements'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoleScopes from identityGovernance
description: The resource roles and scopes in this access package.
operationId: identityGovernance.entitlementManagement.accessPackage_ListResourceRoleScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $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.accessPackageResourceRoleScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create resourceRoleScope
description: 'Create a new accessPackageResourceRoleScope for adding a resource role to an access package. The access package resource, for a group, an app, or a SharePoint Online site, must already exist in the access package catalog, and the originId for the resource role retrieved from the list of the resource roles. Once you add the resource role scope to the access package, the user will receive this resource role through any current and future access package assignments.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-post-resourcerolescopes?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_CreateResourceRoleScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoleScopes from identityGovernance
description: The resource roles and scopes in this access package.
operationId: identityGovernance.entitlementManagement.accessPackage_GetResourceRoleScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceRoleScopes in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage_UpdateResourceRoleScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove resourceRoleScope from an accessPackage
description: Remove an accessPackageResourceRoleScope from an accessPackage list of resource role scopes.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-delete-resourcerolescopes?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_DeleteResourceRoleScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get role from identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_GetRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property role in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_UpdateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property role for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_DeleteRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role_GetResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role_UpdateResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role_DeleteResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_GetEnvironment
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_refresh
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_ListRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_CreateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_GetRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_UpdateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_DeleteRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.role_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_ListScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_CreateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_GetScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_UpdateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_DeleteScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope_GetResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope_UpdateResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope_DeleteResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_refresh
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_ListRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_CreateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_GetRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_UpdateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_DeleteRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.role_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.scope_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_ListUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_CreateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_GetUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_UpdateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource_DeleteUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_ListFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_GetFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.role.resource.uploadSession_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scope from identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_GetScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scope in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_UpdateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scope for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_DeleteScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope_GetResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope_UpdateResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope_DeleteResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_GetEnvironment
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_refresh
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_ListRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_CreateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_GetRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_UpdateRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_DeleteRole
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role_GetResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role_UpdateResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role_DeleteResource
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_refresh
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_ListScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_CreateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_GetScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_UpdateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_DeleteScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.scope_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.role_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_ListScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_CreateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_GetScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_UpdateScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_DeleteScope
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.scope_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_ListUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_CreateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_GetUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_UpdateUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource_DeleteUploadSession
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/resourceRoleScopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage.resourceRoleScope_GetCount
parameters:
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/accessPackages/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackage_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackages/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function filterByCurrentUser
description: 'In Microsoft Entra Entitlement Management, retrieve a list of accessPackage objects filtered on the signed-in user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackage-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackage_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessPackage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/entitlementManagement/accessPackageSuggestions:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageSuggestions from identityGovernance
description: Suggested access packages for end users based on various criteria such as related people insights and assignment history.
operationId: identityGovernance.entitlementManagement_ListAccessPackageSuggestion
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.accessPackageSuggestionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to accessPackageSuggestions for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateAccessPackageSuggestion
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackageSuggestions/{accessPackageSuggestion-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageSuggestions from identityGovernance
description: Suggested access packages for end users based on various criteria such as related people insights and assignment history.
operationId: identityGovernance.entitlementManagement_GetAccessPackageSuggestion
parameters:
- name: accessPackageSuggestion-id
in: path
description: The unique identifier of accessPackageSuggestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSuggestion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property accessPackageSuggestions in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateAccessPackageSuggestion
parameters:
- name: accessPackageSuggestion-id
in: path
description: The unique identifier of accessPackageSuggestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSuggestion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property accessPackageSuggestions for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteAccessPackageSuggestion
parameters:
- name: accessPackageSuggestion-id
in: path
description: The unique identifier of accessPackageSuggestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSuggestion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/accessPackageSuggestions/{accessPackageSuggestion-id}/accessPackage':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackage from identityGovernance
description: The access package information for the suggested package.
operationId: identityGovernance.entitlementManagement.accessPackageSuggestion_GetAccessPackage
parameters:
- name: accessPackageSuggestion-id
in: path
description: The unique identifier of accessPackageSuggestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSuggestion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/accessPackageSuggestions/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.accessPackageSuggestion_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/accessPackageSuggestions/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function filterByCurrentUser
description: Retrieve suggested accessPackageSuggestion objects for the current end user. This operation returns access packages that are suggested based on various criteria such as related people insights and the user's assignment history. The suggestions help end users discover relevant access packages they may need for their role or work context.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagesuggestions-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.accessPackageSuggestion_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestionFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessPackageSuggestion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/entitlementManagement/assignmentPolicies:
get:
tags:
- identityGovernance.entitlementManagement
summary: List assignmentPolicies
description: 'Retrieve a list of accessPackageAssignmentPolicy objects in Microsoft Entra entitlement management. If the delegated user is in a directory role, the resulting list includes all the assignment policies that the caller has access to read, across all catalogs and access packages. If the delegated user is an access package manager or catalog owner, they should instead retrieve the policies for the access packages they can read with list accessPackages by including $expand=assignmentPolicies as a query parameter.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-assignmentpolicies?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListAssignmentPolicy
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.accessPackageAssignmentPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create assignmentPolicies
description: 'Create a new accessPackageAssignmentPolicy object in Microsoft Entra entitlement management. The request includes a reference to the accessPackage that contains this policy, which must already exist.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-post-assignmentpolicies?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_CreateAssignmentPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageAssignmentPolicy
description: "In Microsoft Entra entitlement management, retrieve the properties and relationships of an\r\n accessPackageAssignmentPolicy object."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentpolicy-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetAssignmentPolicy
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- identityGovernance.entitlementManagement
summary: Update accessPackageAssignmentPolicy
description: 'Update an existing accessPackageAssignmentPolicy object to change one or more of its properties, such as the display name or description.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentpolicy-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_SetAssignmentPolicy
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete accessPackageAssignmentPolicy
description: 'In Microsoft Entra entitlement management, delete an accessPackageAssignmentPolicy.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentpolicy-delete?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_DeleteAssignmentPolicy
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/accessPackage':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackage from identityGovernance
description: Access package containing this policy. Read-only. Supports $expand.
operationId: identityGovernance.entitlementManagement.assignmentPolicy_GetAccessPackage
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/catalog':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get catalog from identityGovernance
description: Catalog of the access package containing this policy. Read-only.
operationId: identityGovernance.entitlementManagement.assignmentPolicy_GetCatalog
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customExtensionStageSettings from identityGovernance
description: The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand.
operationId: identityGovernance.entitlementManagement.assignmentPolicy_ListCustomExtensionStageSetting
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $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.customExtensionStageSettingCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to customExtensionStageSettings for identityGovernance
operationId: identityGovernance.entitlementManagement.assignmentPolicy_CreateCustomExtensionStageSetting
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings/{customExtensionStageSetting-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customExtensionStageSettings from identityGovernance
description: The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand.
operationId: identityGovernance.entitlementManagement.assignmentPolicy_GetCustomExtensionStageSetting
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property customExtensionStageSettings in identityGovernance
operationId: identityGovernance.entitlementManagement.assignmentPolicy_UpdateCustomExtensionStageSetting
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property customExtensionStageSettings for identityGovernance
operationId: identityGovernance.entitlementManagement.assignmentPolicy_DeleteCustomExtensionStageSetting
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings/{customExtensionStageSetting-id}/customExtension':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customExtension from identityGovernance
description: Indicates the custom workflow extension that will be executed at this stage. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.assignmentPolicy.customExtensionStageSetting_GetCustomExtension
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: customExtensionStageSetting-id
in: path
description: The unique identifier of customExtensionStageSetting
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customExtensionStageSetting
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/customExtensionStageSettings/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.assignmentPolicy.customExtensionStageSetting_GetCount
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/questions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get questions from identityGovernance
description: Questions that are posed to the requestor.
operationId: identityGovernance.entitlementManagement.assignmentPolicy_ListQuestion
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $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.accessPackageQuestionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to questions for identityGovernance
operationId: identityGovernance.entitlementManagement.assignmentPolicy_CreateQuestion
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/questions/{accessPackageQuestion-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get questions from identityGovernance
description: Questions that are posed to the requestor.
operationId: identityGovernance.entitlementManagement.assignmentPolicy_GetQuestion
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: accessPackageQuestion-id
in: path
description: The unique identifier of accessPackageQuestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageQuestion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property questions in identityGovernance
operationId: identityGovernance.entitlementManagement.assignmentPolicy_UpdateQuestion
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: accessPackageQuestion-id
in: path
description: The unique identifier of accessPackageQuestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageQuestion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property questions for identityGovernance
operationId: identityGovernance.entitlementManagement.assignmentPolicy_DeleteQuestion
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- name: accessPackageQuestion-id
in: path
description: The unique identifier of accessPackageQuestion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageQuestion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/questions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.assignmentPolicy.question_GetCount
parameters:
- name: accessPackageAssignmentPolicy-id
in: path
description: The unique identifier of accessPackageAssignmentPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/assignmentPolicies/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.assignmentPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/assignmentRequests:
get:
tags:
- identityGovernance.entitlementManagement
summary: List assignmentRequests
description: 'In Microsoft Entra entitlement management, retrieve a list of accessPackageAssignmentRequest objects. The resulting list includes all the assignment requests, current and well as expired, that the caller has access to read, across all catalogs and access packages.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-assignmentrequests?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListAssignmentRequest
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.accessPackageAssignmentRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create accessPackageAssignmentRequest
description: 'In Microsoft Entra Entitlement Management, create a new accessPackageAssignmentRequest object. This operation is used to assign a user to an access package, update the assignment, or to remove an access package assignment.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-post-assignmentrequests?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_CreateAssignmentRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageAssignmentRequest
description: 'In Microsoft Entra entitlement management, retrieve the properties and relationships of an accessPackageAssignmentRequest object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequest-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetAssignmentRequest
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property assignmentRequests in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateAssignmentRequest
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete accessPackageAssignmentRequest
description: Delete an accessPackageAssignmentRequest object. This request can be made to remove a denied or completed request. You cannot delete an access package assignment request if it has any accessPackageAssignment objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequest-delete?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_DeleteAssignmentRequest
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/accessPackage':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackage from identityGovernance
description: The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.assignmentRequest_GetAccessPackage
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/assignment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get assignment from identityGovernance
description: 'For a requestType of userAdd or adminAdd, this is an access package assignment requested to be created. For a requestType of userRemove, adminRemove, approverRemove, or systemRemove, this has the id property of an existing assignment to be removed. Supports $expand.'
operationId: identityGovernance.entitlementManagement.assignmentRequest_GetAssignment
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.cancel':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action cancel
description: 'In Microsoft Entra Entitlement Management, cancel accessPackageAssignmentRequest objects that are in a cancellable state: accepted, pendingApproval, pendingNotBefore, pendingApprovalEscalated.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequest-cancel?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignmentRequest_cancel
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.reprocess':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action reprocess
description: 'In Microsoft Entra entitlement management, callers can automatically retry a user''s request for access to an access package. It''s performed on an accessPackageAssignmentRequest object whose requestState is in a DeliveryFailed or PartiallyDelivered state. You can only reprocess a request within 14 days from the time the original request was completed. For requests completed more than 14 days, you will need to ask the users to cancel the request(s) and make a new request in the MyAccess portal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequest-reprocess?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignmentRequest_reprocess
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.resume':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action resume
description: 'Resume a user''s access package request after waiting for a callback from a custom extension. In Microsoft Entra entitlement management, when an access package policy has been enabled to call out a custom extension and the request processing is waiting for the callback from the customer, the customer can initiate a resume action. It''s performed on an accessPackageAssignmentRequest object whose requestStatus is in a WaitingForCallback state.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequest-resume?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignmentRequest_resume
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.customExtensionData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/requestor':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get requestor from identityGovernance
description: 'The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand.'
operationId: identityGovernance.entitlementManagement.assignmentRequest_GetRequestor
parameters:
- name: accessPackageAssignmentRequest-id
in: path
description: The unique identifier of accessPackageAssignmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignmentRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/assignmentRequests/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.assignmentRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/assignmentRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function filterByCurrentUser
description: 'In Microsoft Entra Entitlement Management, retrieve a list of accessPackageAssignmentRequest objects filtered on the signed-in user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequest-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignmentRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessPackageAssignmentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/entitlementManagement/assignments:
get:
tags:
- identityGovernance.entitlementManagement
summary: List assignments
description: 'In Microsoft Entra entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes all the assignments, current and well as expired, that the caller has access to read, across all catalogs and access packages. If the caller is on behalf of a delegated user who is assigned only to catalog-specific delegated administrative roles, the request must supply a filter to indicate a specific access package, such as: $filter=accessPackage/id eq ''a914b616-e04e-476b-aa37-91038f0b165b''.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-assignments?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListAssignment
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.accessPackageAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to assignments for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateAssignment
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageAssignment
description: 'In Microsoft Entra entitlement management, retrieve the properties and relationships of an accessPackageAssignment object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignment-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetAssignment
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property assignments in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateAssignment
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property assignments for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteAssignment
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/accessPackage':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackage from identityGovernance
description: Read-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters.
operationId: identityGovernance.entitlementManagement.assignment_GetAccessPackage
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/assignmentPolicy':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get assignmentPolicy from identityGovernance
description: Read-only. Supports $filter (eq) on the id property and $expand query parameters.
operationId: identityGovernance.entitlementManagement.assignment_GetAssignmentPolicy
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/microsoft.graph.reprocess':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action reprocess
description: 'In Microsoft Entra entitlement management, callers can automatically reevaluate and enforce an accessPackageAssignment object of a user’s assignments for a specific access package. The state of the access package assignment must be Delivered for the administrator to reprocess the user''s assignment. Only admins with the Access Package Assignment Manager role, or higher, in Microsoft Entra entitlement management can perform this action.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignment-reprocess?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignment_reprocess
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/target':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get target from identityGovernance
description: The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId.
operationId: identityGovernance.entitlementManagement.assignment_GetTarget
parameters:
- name: accessPackageAssignment-id
in: path
description: The unique identifier of accessPackageAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/assignments/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.assignment_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/assignments/microsoft.graph.additionalAccess():
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function additionalAccess
description: 'In Microsoft Entra Entitlement Management, retrieve a collection of accessPackageAssignment objects that indicate a target user has an assignment to a specified access package and also an assignment to another, potentially incompatible, access package. This can be used to prepare to configure the incompatible access packages for a specific access package.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignment-additionalaccess?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignment_additionalAccess
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessPackageAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/entitlementManagement/assignments/microsoft.graph.additionalAccess(accessPackageId=''{accessPackageId}'',incompatibleAccessPackageId=''{incompatibleAccessPackageId}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function additionalAccess
operationId: identityGovernance.entitlementManagement.assignment_additionalAccess
parameters:
- name: accessPackageId
in: path
description: 'Usage: accessPackageId=''{accessPackageId}'''
required: true
style: simple
schema:
type: string
nullable: true
- name: incompatibleAccessPackageId
in: path
description: 'Usage: incompatibleAccessPackageId=''{incompatibleAccessPackageId}'''
required: true
style: simple
schema:
type: string
nullable: true
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessPackageAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/entitlementManagement/assignments/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Invoke function filterByCurrentUser
description: 'In Microsoft Entra Entitlement Management, retrieve a list of accessPackageAssignment objects filtered on the signed-in user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignment-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.assignment_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of accessPackageAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/entitlementManagement/availableAccessPackages:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get availableAccessPackages from identityGovernance
description: Access packages available for end users to browse and request.
operationId: identityGovernance.entitlementManagement_ListAvailableAccessPackage
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.availableAccessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to availableAccessPackages for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateAvailableAccessPackage
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/availableAccessPackages/{availableAccessPackage-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get availableAccessPackages from identityGovernance
description: Access packages available for end users to browse and request.
operationId: identityGovernance.entitlementManagement_GetAvailableAccessPackage
parameters:
- name: availableAccessPackage-id
in: path
description: The unique identifier of availableAccessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: availableAccessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property availableAccessPackages in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateAvailableAccessPackage
parameters:
- name: availableAccessPackage-id
in: path
description: The unique identifier of availableAccessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: availableAccessPackage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property availableAccessPackages for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteAvailableAccessPackage
parameters:
- name: availableAccessPackage-id
in: path
description: The unique identifier of availableAccessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: availableAccessPackage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/availableAccessPackages/{availableAccessPackage-id}/resourceRoleScopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: List resourceRoleScopes
description: Get a list of the accessPackageResourceRoleScope objects associated with an availableAccessPackage.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/availableaccesspackage-list-resourcerolescopes?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.availableAccessPackage_ListResourceRoleScope
parameters:
- name: availableAccessPackage-id
in: path
description: The unique identifier of availableAccessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: availableAccessPackage
- $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.accessPackageResourceRoleScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/availableAccessPackages/{availableAccessPackage-id}/resourceRoleScopes/{accessPackageResourceRoleScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoleScopes from identityGovernance
description: The resource role scopes associated with this available access package.
operationId: identityGovernance.entitlementManagement.availableAccessPackage_GetResourceRoleScope
parameters:
- name: availableAccessPackage-id
in: path
description: The unique identifier of availableAccessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: availableAccessPackage
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/availableAccessPackages/{availableAccessPackage-id}/resourceRoleScopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.availableAccessPackage.resourceRoleScope_GetCount
parameters:
- name: availableAccessPackage-id
in: path
description: The unique identifier of availableAccessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: availableAccessPackage
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/availableAccessPackages/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.availableAccessPackage_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/catalogs:
get:
tags:
- identityGovernance.entitlementManagement
summary: List catalogs
description: Retrieve a list of accessPackageCatalog objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-catalogs?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListCatalog
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.accessPackageCatalogCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create accessPackageCatalog
description: Create a new accessPackageCatalog object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-post-catalogs?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_CreateCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageCatalog
description: Retrieve the properties and relationships of an accessPackageCatalog object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetCatalog
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update accessPackageCatalog
description: 'Update an existing accessPackageCatalog object to change one or more of its properties, such as the display name or description.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_UpdateCatalog
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete accessPackageCatalog
description: Delete an accessPackageCatalog.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-delete?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_DeleteCatalog
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackages from identityGovernance
description: The access packages in this catalog. Read-only. Nullable.
operationId: identityGovernance.entitlementManagement.catalog_ListAccessPackage
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackages from identityGovernance
description: The access packages in this catalog. Read-only. Nullable.
operationId: identityGovernance.entitlementManagement.catalog_GetAccessPackage
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.accessPackage_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/customWorkflowExtensions':
get:
tags:
- identityGovernance.entitlementManagement
summary: List accessPackageCustomWorkflowExtensions
description: List the accessPackageAssignmentRequestWorkflowExtension and accessPackageAssignmentWorkflowExtension objects in the accessPackageCustomWorkflowExtensions relationship of an accessPackageCatalog. The resulting list includes all the customAccessPackageWorkflowExtension objects for the catalog that the caller has access to read. Each object includes an @odata.type property that indicates whether the object is an accessPackageAssignmentRequestWorkflowExtension or an accessPackageAssignmentWorkflowExtension.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-list-accesspackagecustomworkflowextensions?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_ListCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.customCalloutExtensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create accessPackageCustomWorkflowExtension
description: Create a new accessPackageAssignmentRequestWorkflowExtension or accessPackageAssignmentWorkflowExtension object in the accessPackageCustomWorkflowExtensions relationship of an accessPackageCatalog. You must explicitly provide an @odata.type property that indicates whether the object is an accessPackageAssignmentRequestWorkflowExtension or an accessPackageAssignmentWorkflowExtension.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-post-accesspackagecustomworkflowextensions?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_CreateCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/customWorkflowExtensions/{customCalloutExtension-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageAssignmentRequestWorkflowExtension
description: Read the properties and relationships of an accessPackageAssignmentRequestWorkflowExtension object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequestworkflowextension-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_GetCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update accessPackageAssignmentRequestWorkflowExtension
description: Update the properties of an accessPackageAssignmentRequestWorkflowExtension object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequestworkflowextension-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_UpdateCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete accessPackageAssignmentRequestWorkflowExtension
description: 'Delete an accessPackageAssignmentRequestWorkflowExtension object. The custom workflow extension must first be removed from any associated policies before it can be deleted. Follow these steps to remove the custom workflow extension from any associated policies:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageassignmentrequestworkflowextension-delete?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_DeleteCustomWorkflowExtension
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/customWorkflowExtensions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.customWorkflowExtension_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles':
get:
tags:
- identityGovernance.entitlementManagement
summary: List resourceRoles
description: 'Retrieve a list of accessPackageResourceRole objects of an accessPackageResource in an accessPackageCatalog. The resource should have been added to the catalog by creating an accessPackageResourceRequest. This list of roles can then be used by the caller to select a role, which is needed when subsequently creating an accessPackageResourceRoleScope.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-list-resourceroles?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_ListResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resourceRoles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_CreateResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoles from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_GetResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceRoles in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_UpdateResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceRoles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_DeleteResourceRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/roles/{accessPackageResourceRole-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceRoles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceRole_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources':
get:
tags:
- identityGovernance.entitlementManagement
summary: List resources
description: Retrieve a list of accessPackageResource objects in an accessPackageCatalog.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagecatalog-list-resources?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog_ListResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageResourceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resources for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_CreateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: Access package resources in this catalog.
operationId: identityGovernance.entitlementManagement.catalog_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resources in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resources for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: List customDataProvidedResourceUploadSession objects
description: Get a list of the customDataProvidedResourceUploadSession objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageresource-list-uploadsessions?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create customDataProvidedResourceUploadSession
description: 'Create a customDataProvidedResourceUploadSession object. Only one upload session is allowed per reference instance (for example, access review instance) and accessPackageResource pair. Once you create an upload session, upload files, and complete the session, the data is processed and you cannot create another upload session for that same pair. If you encounter errors with files uploaded or need to start fresh, you can delete the active upload session to create a new one. The following table lists the derived types of customDataProvidedResourceUploadSession that can be created. Specify the @odata.type in the request body to indicate the derived type.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageresource-post-uploadsessions?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customDataProvidedResourceUploadSession
description: Read the properties and relationships of a customDataProvidedResourceUploadSession object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update customDataProvidedResourceUploadSession
description: Update the properties of a customDataProvidedResourceUploadSession created for an accessPackageResource object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete customDataProvidedResourceUploadSession
description: Delete a customDataProvidedResourceUploadSession object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackageresource-delete-uploadsessions?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/{accessPackageResource-id}/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resources/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resource_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceScopes from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_ListResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resourceScopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_CreateResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceScopes from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_GetResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceScopes in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_UpdateResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceScopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog_DeleteResourceScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_ListRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_CreateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_GetRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_UpdateRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_DeleteRole
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role_GetResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role_UpdateResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role_DeleteResource
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_refresh
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.role_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_ListScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_CreateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/scopes/{accessPackageResourceScope-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_GetScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_UpdateScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_DeleteScope
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.scope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_ListUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_CreateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_GetUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_UpdateUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource_DeleteUploadSession
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_ListFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_GetFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope.resource.uploadSession_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/resourceScopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog.resourceScope_GetCount
parameters:
- name: accessPackageCatalog-id
in: path
description: The unique identifier of accessPackageCatalog
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageCatalog
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/catalogs/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.catalog_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/connectedOrganizations:
get:
tags:
- identityGovernance.entitlementManagement
summary: List connectedOrganizations
description: Retrieve a list of connectedOrganization objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-connectedorganizations?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListConnectedOrganization
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.connectedOrganizationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create connectedOrganization
description: Create a new connectedOrganization object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-post-connectedorganizations?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_CreateConnectedOrganization
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get connectedOrganization
description: Retrieve the properties and relationships of a connectedOrganization object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetConnectedOrganization
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update connectedOrganization
description: Update a connectedOrganization object to change one or more of its properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_UpdateConnectedOrganization
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete connectedOrganization
description: Delete a connectedOrganization object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-delete?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_DeleteConnectedOrganization
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get externalSponsors from identityGovernance
operationId: identityGovernance.entitlementManagement.connectedOrganization_ListExternalSponsor
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/{directoryObject-id}/$ref':
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove externalSponsors
description: Remove a user or a group from the externalSponsors relationship of a connectedOrganization. External sponsors are a set of users who can approve requests on behalf of other users from that connected organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-delete-externalsponsors?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.connectedOrganization.externalSponsor_DeleteDirectoryObjectGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.connectedOrganization.externalSponsor_GetCount
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/$ref':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get ref of externalSponsors from identityGovernance
operationId: identityGovernance.entitlementManagement.connectedOrganization_ListExternalSponsorGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Add externalSponsors
description: Add a user or a group to the externalSponsors relationship of a connectedOrganization. External sponsors are a set of users who can approve requests on behalf of other users from that connected organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-post-externalsponsors?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.connectedOrganization_CreateExternalSponsorGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove externalSponsors
description: Remove a user or a group from the externalSponsors relationship of a connectedOrganization. External sponsors are a set of users who can approve requests on behalf of other users from that connected organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-delete-externalsponsors?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.connectedOrganization_DeleteExternalSponsorGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get internalSponsors from identityGovernance
operationId: identityGovernance.entitlementManagement.connectedOrganization_ListInternalSponsor
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/{directoryObject-id}/$ref':
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove internalSponsors
description: Remove a user or a group from the internalSponsors relationship of a connectedOrganization. Internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-delete-internalsponsors?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.connectedOrganization.internalSponsor_DeleteDirectoryObjectGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.connectedOrganization.internalSponsor_GetCount
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/$ref':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get ref of internalSponsors from identityGovernance
operationId: identityGovernance.entitlementManagement.connectedOrganization_ListInternalSponsorGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Add internalSponsors
description: Add a user or a group to the internalSponsors relationship of a connectedOrganization. Internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-post-internalsponsors?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.connectedOrganization_CreateInternalSponsorGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Remove internalSponsors
description: Remove a user or a group from the internalSponsors relationship of a connectedOrganization. Internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectedorganization-delete-internalsponsors?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.connectedOrganization_DeleteInternalSponsorGraphBPreRef
parameters:
- name: connectedOrganization-id
in: path
description: The unique identifier of connectedOrganization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: connectedOrganization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/connectedOrganizations/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.connectedOrganization_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/controlConfigurations:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get controlConfigurations from identityGovernance
description: Configuration settings that control the lifecycle and access policies of entitlement management within a tenant.
operationId: identityGovernance.entitlementManagement_ListControlConfiguration
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.controlConfigurationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to controlConfigurations for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateControlConfiguration
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/controlConfigurations/{controlConfiguration-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get controlConfigurations from identityGovernance
description: Configuration settings that control the lifecycle and access policies of entitlement management within a tenant.
operationId: identityGovernance.entitlementManagement_GetControlConfiguration
parameters:
- name: controlConfiguration-id
in: path
description: The unique identifier of controlConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: controlConfiguration
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property controlConfigurations in identityGovernance
operationId: identityGovernance.entitlementManagement_SetControlConfiguration
parameters:
- name: controlConfiguration-id
in: path
description: The unique identifier of controlConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: controlConfiguration
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property controlConfigurations for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteControlConfiguration
parameters:
- name: controlConfiguration-id
in: path
description: The unique identifier of controlConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: controlConfiguration
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/controlConfigurations/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.controlConfiguration_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resourceEnvironments:
get:
tags:
- identityGovernance.entitlementManagement
summary: List accessPackageResourceEnvironments
description: Retrieve a list of accessPackageResourceEnvironment objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-resourceenvironments?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListResourceEnvironment
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.accessPackageResourceEnvironmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resourceEnvironments for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateResourceEnvironment
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceEnvironments from identityGovernance
description: A reference to the geolocation environments in which a resource is located.
operationId: identityGovernance.entitlementManagement_GetResourceEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceEnvironments in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateResourceEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceEnvironments for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteResourceEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: Read-only. Required.
operationId: identityGovernance.entitlementManagement.resourceEnvironment_ListResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- $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.accessPackageResourceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resources for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment_CreateResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: Read-only. Required.
operationId: identityGovernance.entitlementManagement.resourceEnvironment_GetResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resources in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment_UpdateResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resources for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment_DeleteResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_GetEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_refresh
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_ListRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_CreateRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_GetRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_UpdateRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_DeleteRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role_GetResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role_UpdateResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role_DeleteResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_refresh
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_ListScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_CreateScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_GetScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_UpdateScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_DeleteScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope_GetResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.role_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_ListScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_CreateScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_GetScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_UpdateScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_DeleteScope
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope_GetResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_ListRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_CreateRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_GetRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role_GetResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role_UpdateResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role_DeleteResource
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_refresh
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.scope_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_ListUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_CreateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_GetUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/{accessPackageResource-id}/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceEnvironments/{accessPackageResourceEnvironment-id}/resources/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment.resource_GetCount
parameters:
- name: accessPackageResourceEnvironment-id
in: path
description: The unique identifier of accessPackageResourceEnvironment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceEnvironment
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resourceEnvironments/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceEnvironment_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resourceRequests:
get:
tags:
- identityGovernance.entitlementManagement
summary: List accessPackageResourceRequests
description: Retrieve a list of accessPackageResourceRequest objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-list-resourcerequests?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListResourceRequest
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.accessPackageResourceRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create accessPackageResourceRequest
description: 'Create a new accessPackageResourceRequest object to request the addition of a resource to an access package catalog, update of a resource, or the removal of a resource from a catalog. A resource must be included in an access package catalog before a role of that resource can be added to an access package.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagement-post-resourcerequests?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_CreateResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRequests from identityGovernance
description: Represents a request to add or remove a resource to or from a catalog respectively.
operationId: identityGovernance.entitlementManagement_GetResourceRequest
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceRequests in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateResourceRequest
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceRequests for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteResourceRequest
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get catalog from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest_GetCatalog
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property catalog in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest_UpdateCatalog
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property catalog for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest_DeleteCatalog
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/accessPackages':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackages from identityGovernance
description: The access packages in this catalog. Read-only. Nullable.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_ListAccessPackage
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.accessPackageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/accessPackages/{accessPackage-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackages from identityGovernance
description: The access packages in this catalog. Read-only. Nullable.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_GetAccessPackage
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackage-id
in: path
description: The unique identifier of accessPackage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/accessPackages/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.accessPackage_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/customWorkflowExtensions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customWorkflowExtensions from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_ListCustomWorkflowExtension
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.customCalloutExtensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to customWorkflowExtensions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_CreateCustomWorkflowExtension
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/customWorkflowExtensions/{customCalloutExtension-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get customWorkflowExtensions from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_GetCustomWorkflowExtension
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property customWorkflowExtensions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_UpdateCustomWorkflowExtension
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property customWorkflowExtensions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_DeleteCustomWorkflowExtension
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customCalloutExtension-id
in: path
description: The unique identifier of customCalloutExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customCalloutExtension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/customWorkflowExtensions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.customWorkflowExtension_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoles from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_ListResourceRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resourceRoles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_CreateResourceRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoles from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_GetResourceRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceRoles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_UpdateResourceRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceRoles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_DeleteResourceRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/roles/{accessPackageResourceRole-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id1
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceRoles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceRole_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: Access package resources in this catalog.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_ListResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.accessPackageResourceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resources for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_CreateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: Access package resources in this catalog.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resources in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resources for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/{accessPackageResource-id}/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resources/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resource_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceScopes from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_ListResourceScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resourceScopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_CreateResourceScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceScopes from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_GetResourceScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceScopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_UpdateResourceScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceScopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog_DeleteResourceScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/scopes/{accessPackageResourceScope-id1}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceScope-id1
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/catalog/resourceScopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.catalog.resourceScope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_ListScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_CreateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_GetScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_UpdateScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_DeleteScope
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_ListRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_CreateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_GetRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role_GetResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role_UpdateResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role_DeleteResource
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_refresh
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.scope_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_ListUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_GetUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRequest.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRequests/{accessPackageResourceRequest-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRequest-id
in: path
description: The unique identifier of accessPackageResourceRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resourceRequests/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resourceRoleScopes:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoleScopes from identityGovernance
operationId: identityGovernance.entitlementManagement_ListResourceRoleScope
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.accessPackageResourceRoleScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resourceRoleScopes for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resourceRoleScopes from identityGovernance
operationId: identityGovernance.entitlementManagement_GetResourceRoleScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resourceRoleScopes in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateResourceRoleScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resourceRoleScopes for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteResourceRoleScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get role from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope_GetRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property role in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope_UpdateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property role for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope_DeleteRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role_GetResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role_UpdateResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role_DeleteResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_refresh
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_ListRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_CreateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_GetRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_UpdateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_DeleteRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.role_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_ListScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_CreateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_GetScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_UpdateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_DeleteScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope_GetResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope_UpdateResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope_DeleteResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_refresh
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_ListRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_CreateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_GetRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.scope_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/role/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scope from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope_GetScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scope in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope_UpdateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scope for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope_DeleteScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope_GetResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope_UpdateResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope_DeleteResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_GetEnvironment
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_refresh
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_ListRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_CreateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_GetRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_UpdateRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_DeleteRole
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role_GetResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role_UpdateResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role_DeleteResource
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_refresh
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_ListScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_CreateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_GetScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_UpdateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_DeleteScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.role_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_ListScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_CreateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_GetScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_UpdateScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_DeleteScope
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.scope_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_ListUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_GetUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resourceRoleScopes/{accessPackageResourceRoleScope-id}/scope/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResourceRoleScope-id
in: path
description: The unique identifier of accessPackageResourceRoleScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRoleScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resourceRoleScopes/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resourceRoleScope_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resources:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: The resources associated with the catalogs.
operationId: identityGovernance.entitlementManagement_ListResource
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.accessPackageResourceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to resources for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resources from identityGovernance
description: The resources associated with the catalogs.
operationId: identityGovernance.entitlementManagement_GetResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resources in identityGovernance
operationId: identityGovernance.entitlementManagement_UpdateResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resources for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resource_GetEnvironment
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resource_refresh
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource_ListRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resource_CreateRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource_GetRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resource_UpdateRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resource_DeleteRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role_GetResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role_UpdateResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role_DeleteResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resource.role.resource_refresh
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.role.resource_ListScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource_CreateScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.role.resource_GetScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource_UpdateScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource_DeleteScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope_GetResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope_UpdateResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope_DeleteResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_refresh
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.role.resource.scope_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.role_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource_ListScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.accessPackageResourceScopeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resource_CreateScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get scopes from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource_GetScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property scopes in identityGovernance
operationId: identityGovernance.entitlementManagement.resource_UpdateScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property scopes for identityGovernance
operationId: identityGovernance.entitlementManagement.resource_DeleteScope
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope_GetResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope_UpdateResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope_DeleteResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.scope.resource_GetEnvironment
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resource.scope.resource_refresh
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.scope.resource_ListRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.accessPackageResourceRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource_CreateRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get roles from identityGovernance
description: Read-only. Nullable. Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.scope.resource_GetRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property roles in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource_UpdateRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property roles for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource_DeleteRole
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get resource from identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role_GetResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property resource in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role_UpdateResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property resource for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role_DeleteResource
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/environment':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get environment from identityGovernance
description: Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_GetEnvironment
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/microsoft.graph.refresh':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action refresh
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_refresh
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_ListUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_CreateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_GetUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_UpdateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource_DeleteUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_ListFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_GetFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/{accessPackageResourceRole-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role.resource.uploadSession_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: accessPackageResourceRole-id
in: path
description: The unique identifier of accessPackageResourceRole
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceRole
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/roles/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.scope.resource.role_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.scope.resource_ListUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource_CreateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource.scope.resource_GetUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource_UpdateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource.scope.resource_DeleteUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_ListFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_GetFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/{accessPackageResourceScope-id}/resource/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.scope.resource.uploadSession_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: accessPackageResourceScope-id
in: path
description: The unique identifier of accessPackageResourceScope
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResourceScope
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/scopes/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.scope_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource_ListUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $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.customDataProvidedResourceUploadSessionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource_CreateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get uploadSessions from identityGovernance
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
operationId: identityGovernance.entitlementManagement.resource_GetUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update the navigation property uploadSessions in identityGovernance
operationId: identityGovernance.entitlementManagement.resource_UpdateUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property uploadSessions for identityGovernance
operationId: identityGovernance.entitlementManagement.resource_DeleteUploadSession
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.uploadSession_ListFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $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.customDataProvidedResourceFileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get files from identityGovernance
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
operationId: identityGovernance.entitlementManagement.resource.uploadSession_GetFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/{customDataProvidedResourceFile-id}/$value':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get media content for the navigation property files from identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.uploadSession_GetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identityGovernance.entitlementManagement
summary: Update media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.uploadSession_SetFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete media content for the navigation property files in identityGovernance
description: The unique identifier for an entity. Read-only.
operationId: identityGovernance.entitlementManagement.resource.uploadSession_DeleteFilesContent
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- name: customDataProvidedResourceFile-id
in: path
description: The unique identifier of customDataProvidedResourceFile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceFile
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/files/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.uploadSession.file_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/{customDataProvidedResourceUploadSession-id}/microsoft.graph.uploadFile':
post:
tags:
- identityGovernance.entitlementManagement
summary: Invoke action uploadFile
description: Upload a file in a customDataProvidedResourceUploadSession created for an accessPackageResource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customdataprovidedresourceuploadsession-uploadfile?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.resource.uploadSession_uploadFile
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- name: customDataProvidedResourceUploadSession-id
in: path
description: The unique identifier of customDataProvidedResourceUploadSession
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customDataProvidedResourceUploadSession
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/entitlementManagement/resources/{accessPackageResource-id}/uploadSessions/$count':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource.uploadSession_GetCount
parameters:
- name: accessPackageResource-id
in: path
description: The unique identifier of accessPackageResource
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageResource
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/resources/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.resource_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/entitlementManagement/settings:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get entitlementManagementSettings
description: Retrieve the properties of an entitlementManagementSettings object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagementsettings-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_GetSetting
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update entitlementManagementSettings
description: Update an existing entitlementManagementSettings object to change one or more of its properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/entitlementmanagementsettings-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_UpdateSetting
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property settings for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteSetting
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/subjects:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get accessPackageSubject
description: Get the properties of an external directory user represented by an existing accessPackageSubject object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagesubject-get?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_ListSubject
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.accessPackageSubjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.entitlementManagement
summary: Create new navigation property to subjects for identityGovernance
operationId: identityGovernance.entitlementManagement_CreateSubject
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/subjects/{accessPackageSubject-id}':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get subjects from identityGovernance
operationId: identityGovernance.entitlementManagement_GetSubject
parameters:
- name: accessPackageSubject-id
in: path
description: The unique identifier of accessPackageSubject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSubject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update accessPackageSubject
description: Update an external directory user represented by an existing accessPackageSubject object to change the subject lifecycle.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagesubject-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement_UpdateSubject
parameters:
- name: accessPackageSubject-id
in: path
description: The unique identifier of accessPackageSubject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSubject
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property subjects for identityGovernance
operationId: identityGovernance.entitlementManagement_DeleteSubject
parameters:
- name: accessPackageSubject-id
in: path
description: The unique identifier of accessPackageSubject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSubject
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/subjects/{accessPackageSubject-id}/connectedOrganization':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get connectedOrganization from identityGovernance
description: The connected organization of the subject. Read-only. Nullable.
operationId: identityGovernance.entitlementManagement.subject_GetConnectedOrganization
parameters:
- name: accessPackageSubject-id
in: path
description: The unique identifier of accessPackageSubject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: accessPackageSubject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/entitlementManagement/subjects(objectId=''{objectId}'')':
get:
tags:
- identityGovernance.entitlementManagement
summary: Get subjects from identityGovernance
operationId: identityGovernance.entitlementManagement.subject_GetGraphBPreObjectId
parameters:
- name: objectId
in: path
description: Alternate key of accessPackageSubject
required: true
style: simple
schema:
type: string
nullable: true
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.entitlementManagement
summary: Update accessPackageSubject
description: Update an external directory user represented by an existing accessPackageSubject object to change the subject lifecycle.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/accesspackagesubject-update?view=graph-rest-1.0
operationId: identityGovernance.entitlementManagement.subject_UpdateGraphBPreObjectId
parameters:
- name: objectId
in: path
description: Alternate key of accessPackageSubject
required: true
style: simple
schema:
type: string
nullable: true
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.entitlementManagement
summary: Delete navigation property subjects for identityGovernance
operationId: identityGovernance.entitlementManagement.subject_DeleteGraphBPreObjectId
parameters:
- name: objectId
in: path
description: Alternate key of accessPackageSubject
required: true
style: simple
schema:
type: string
nullable: true
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/entitlementManagement/subjects/$count:
get:
tags:
- identityGovernance.entitlementManagement
summary: Get the number of the resource
operationId: identityGovernance.entitlementManagement.subject_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lifecycleWorkflows from identityGovernance
operationId: identityGovernance_GetLifecycleWorkflow
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowsContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update the navigation property lifecycleWorkflows in identityGovernance
operationId: identityGovernance_UpdateLifecycleWorkflow
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowsContainer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowsContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property lifecycleWorkflows for identityGovernance
operationId: identityGovernance_DeleteLifecycleWorkflow
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/lifecycleWorkflows/customTaskExtensions:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List customTaskExtensions
description: Get a list of the customTaskExtension objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-list-customtaskextensions?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_ListCustomTaskExtension
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.identityGovernance.customTaskExtensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Create customTaskExtensions
description: Create a new customTaskExtension object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-post-customtaskextensions?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_CreateCustomTaskExtension
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get customTaskExtension
description: Read the properties and relationships of a customTaskExtension object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-customtaskextension-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_GetCustomTaskExtension
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update customTaskExtension
description: Update the properties of a customTaskExtension object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-customtaskextension-update?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_UpdateCustomTaskExtension
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete customTaskExtension
description: Delete a customTaskExtension object. A custom task extension can only be deleted if it is not referenced in any task objects in a lifecycle workflow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-customtaskextension-delete?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_DeleteCustomTaskExtension
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/createdBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get createdBy from identityGovernance
description: 'The unique identifier of the Microsoft Entra user that created the custom task extension.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension_GetCreatedGraphBPre
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/createdBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.createdBy_GetMailboxSetting
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.createdBy_UpdateMailboxSetting
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/createdBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.createdBy_ListServiceProvisioningError
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/createdBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.createdBy.ServiceProvisioningError_GetCount
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/lastModifiedBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lastModifiedBy from identityGovernance
description: 'The unique identifier of the Microsoft Entra user that modified the custom task extension last.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension_GetLastModifiedGraphBPre
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/lastModifiedBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.lastModifiedBy_GetMailboxSetting
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.lastModifiedBy_UpdateMailboxSetting
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/lastModifiedBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.lastModifiedBy_ListServiceProvisioningError
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/customTaskExtensions/{customTaskExtension-id}/lastModifiedBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension.lastModifiedBy.ServiceProvisioningError_GetCount
parameters:
- name: customTaskExtension-id
in: path
description: The unique identifier of customTaskExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customTaskExtension
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/customTaskExtensions/$count:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.customTaskExtension_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/deletedItems:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get deletedItems from identityGovernance
description: Deleted workflows in your lifecycle workflows instance.
operationId: identityGovernance.lifecycleWorkflow_GetDeletedItem
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deletedItemContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property deletedItems for identityGovernance
operationId: identityGovernance.lifecycleWorkflow_DeleteDeletedItem
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/lifecycleWorkflows/deletedItems/workflows:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List deletedItems (deleted lifecycle workflows)
description: Get a list of deleted workflow objects and their properties from the deletedItemContainer.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-list-deleteditems?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem_ListWorkflow
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.identityGovernance.workflowCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get deletedItemContainer (a deleted lifecycle workflow)
description: Retrieve a deleted workflow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-deleteditemcontainer-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem_GetWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete deletedItemContainer (permanently delete a deleted lifecycle workflow)
description: Delete a workflow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-deleteditemcontainer-delete?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem_DeleteWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/administrationScopeTargets':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/administrationScopeTargets/{directoryObject-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/administrationScopeTargets/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.administrationScopeTarget_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/createdBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get createdBy from identityGovernance
description: The user who created the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetCreatedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/createdBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.createdBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.createdBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/createdBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.createdBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/createdBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.createdBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/executionScope':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get executionScope from identityGovernance
description: The list of users that meet the workflowExecutionConditions of a workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListExecutionScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.userProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/executionScope/{userProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get executionScope from identityGovernance
description: The list of users that meet the workflowExecutionConditions of a workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetExecutionScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/executionScope/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.executionScope_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/lastModifiedBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lastModifiedBy from identityGovernance
description: The unique identifier of the Microsoft Entra identity that last modified the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetLastModifiedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/lastModifiedBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.lastModifiedBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.lastModifiedBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/lastModifiedBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.lastModifiedBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/lastModifiedBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.lastModifiedBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.activate':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action activate
description: 'Run a workflow object on-demand. You can run any workflow on-demand, including scheduled workflows. Workflows created from the ''Real-time employee termination'' template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-activate?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_activate
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
subjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.activateWithScope':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action activateWithScope
description: 'Run a workflow object on-demand with a specific scope. You can run any workflow on-demand, including scheduled workflows. Workflows created from the ''Real-time employee termination'' template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-activatewithscope?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_activateGraphWPreScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
scope:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.activationScope'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.cancelProcessing':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action cancelProcessing
description: Cancel one or more workflow runs that are currently in queued or inProgress status. Currently limited to canceling one run per request.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-cancelprocessing?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_cancelProcessing
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
scope:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.cancelScope'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.clearQuarantine':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action clearQuarantine
description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_clearQuarantine
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.createNewVersion':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action createNewVersion
description: Create a new version of the workflow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-createnewversion?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_createNewVersion
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
workflow:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.previewTaskFailures':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action previewTaskFailures
description: 'Validate the tasks configured in a workflow to check for configuration errors. This action identifies any tasks that would fail during execution, allowing you to fix issues before running the workflow. Returns an empty collection if no task failures are detected.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-previewtaskfailures?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_previewTaskFailure
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.previewFailedTask'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.previewWorkflow':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action previewWorkflow
description: 'Run a workflow in preview mode for selected directory objects without affecting production users. This action triggers workflow processing in preview mode, and results can be retrieved by using the List userProcessingResults operation with $filter=workflowExecutionType eq ''previewMode''.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-previewworkflow?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_previewWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
subjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/microsoft.graph.identityGovernance.restore':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action restore
description: Restore a deleted workflow object. You can only restore a workflow that was deleted within the last 30 days before Microsoft Entra ID automatically permanently deletes it.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-restore?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_restore
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/previewScope':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get previewScope from identityGovernance
description: The preview scope for the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListPreviewScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/previewScope/{directoryObject-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get previewScope from identityGovernance
description: The preview scope for the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetPreviewScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/previewScope/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.previewScope_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get runs from identityGovernance
description: Workflow runs.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get runs from identityGovernance
description: Workflow runs.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/reprocessedRuns':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_ListReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/reprocessedRuns/{run-id1}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_GetReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: run-id1
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/reprocessedRuns/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.reprocessedRun_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The related taskProcessingResults.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The related taskProcessingResults.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get userProcessingResults from identityGovernance
description: The associated individual user execution.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_ListUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $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.identityGovernance.userProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get userProcessingResults from identityGovernance
description: The associated individual user execution.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_GetUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_ListReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/{run-id1}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_GetReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: run-id1
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.reprocessedRun_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the user targeted for the taskProcessingResult.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The associated individual task execution.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The associated individual task execution.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run.userProcessingResult_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/runs/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.run_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.runSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskReports from identityGovernance
description: Represents the aggregation of task execution data for tasks within a workflow object.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListTaskReport
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.taskReportCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskReports from identityGovernance
description: Represents the aggregation of task execution data for tasks within a workflow object.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetTaskReport
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskReport'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: 'The related lifecycle workflow task.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskDefinition':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskDefinition from identityGovernance
description: 'The taskDefinition associated with the related lifecycle workflow task.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport_GetTaskDefinition
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The related lifecycle workflow taskProcessingResults.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The related lifecycle workflow taskProcessingResults.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/taskReports/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.taskReport_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskReportSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get tasks from identityGovernance
description: The tasks in the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.taskCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Create new navigation property to tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_CreateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get tasks from identityGovernance
description: The tasks in the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update the navigation property tasks in identityGovernance
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_UpdateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_DeleteTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/tasks/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.task_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get userProcessingResults from identityGovernance
description: Per-user workflow execution results.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.userProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get userProcessingResults from identityGovernance
description: Per-user workflow execution results.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_ListReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/{run-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_GetReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.reprocessedRun_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the user targeted for the taskProcessingResult.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The associated individual task execution.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The associated individual task execution.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/userProcessingResults/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.userProcessingResult_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get versions from identityGovernance
description: The workflow versions that are available.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_ListVersion
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.workflowVersionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get versions from identityGovernance
description: The workflow versions that are available.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetVersion
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/administrationScopeTargets':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_ListAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/administrationScopeTargets/{directoryObject-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_GetAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/administrationScopeTargets/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.administrationScopeTarget_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get createdBy from identityGovernance
description: The user who created the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_GetCreatedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.createdBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.createdBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.createdBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.createdBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lastModifiedBy from identityGovernance
description: The unique identifier of the Microsoft Entra identity that last modified the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_GetLastModifiedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.lastModifiedBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.lastModifiedBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.lastModifiedBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.lastModifiedBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get tasks from identityGovernance
description: The tasks in the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_ListTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.identityGovernance.taskCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Create new navigation property to tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_CreateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get tasks from identityGovernance
description: The tasks in the workflow.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update the navigation property tasks in identityGovernance
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_UpdateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_DeleteTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version.task_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/deletedItems/workflows/{workflow-id}/versions/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow.version_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/deletedItems/workflows/$count:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.deletedItem.workflow_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/insights:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get insights from identityGovernance
description: The insight container holding workflow insight summaries for a tenant.
operationId: identityGovernance.lifecycleWorkflow_GetInsight
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.insights'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update the navigation property insights in identityGovernance
operationId: identityGovernance.lifecycleWorkflow_UpdateInsight
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.insights'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.insights'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property insights for identityGovernance
operationId: identityGovernance.lifecycleWorkflow_DeleteInsight
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.topTasksProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function topTasksProcessedSummary
description: 'Provide a summary from the insights resource of the most processed task objects, known as top tasks, for a specified time period in a tenant. The task definition is provided, along with numerical counts of total, successful, and failed runs. For information about workflows processed, see insights: topWorkflowsProcessedSummary.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-insights-toptasksprocessedsummary?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.insight_topTasksProcessedSummary
parameters:
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.topTasksInsightsSummary'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.topWorkflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function topWorkflowsProcessedSummary
description: 'Provide a summary from the insights resource of the workflow objects processed the most, known as top workflows, for a specified period in a tenant. Workflow basic details are given, along with run information. For information about tasks processed, see insights: topTasksProcessedSummary.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-insights-topworkflowsprocessedsummary?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.insight_topWorkflowsProcessedSummary
parameters:
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.topWorkflowsInsightsSummary'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.workflowsProcessedByCategory(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function workflowsProcessedByCategory
description: 'Provide a summary from the insights resource of workflow objects processed by category in a tenant. This allows you to quickly get category information, by numerical value, without retrieving the other information included in the workflowsProcessedSummary call.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-insights-workflowsprocessedbycategory?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.insight_workflowsProcessedGraphBPreCategory
parameters:
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowsInsightsByCategory'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.workflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function workflowsProcessedSummary
description: 'Provide a summary from the insights resource of workflow objects processed within a tenant for a specified period. Because the list returned by List workflows doesn''t indicate which workflows were processed, this summary gives you a quick overview based on counts.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-insights-workflowsprocessedsummary?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.insight_workflowsProcessedSummary
parameters:
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowsInsightsSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/identityGovernance/lifecycleWorkflows/settings:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lifecycleManagementSettings
description: Read the properties and relationships of a lifecycleManagementSettings object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecyclemanagementsettings-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_GetSetting
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleManagementSettings'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update lifecycleManagementSettings
description: Update the properties of a lifecycleManagementSettings object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecyclemanagementsettings-update?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_UpdateSetting
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleManagementSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleManagementSettings'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/lifecycleWorkflows/taskDefinitions:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List taskDefinitions
description: Get a list of built-in tasks in Lifecycle Workflows. A task is represented by the taskDefinition object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_ListTaskDefinition
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.identityGovernance.taskDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/taskDefinitions/{taskDefinition-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskDefinition
description: Read the details of a built-in workflow task in Lifecycle Workflows.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskdefinition-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_GetTaskDefinition
parameters:
- name: taskDefinition-id
in: path
description: The unique identifier of taskDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/lifecycleWorkflows/taskDefinitions/$count:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.taskDefinition_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/workflows:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List workflows
description: Get a list of workflow resources that are associated with Lifecycle Workflows.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-list-workflows?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_ListWorkflow
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.identityGovernance.workflowCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Create workflow
description: Create a new workflow object. You can create up to 100 workflows in a tenant.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-post-workflows?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_CreateWorkflow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get workflow
description: Read the properties and relationships of a workflow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_GetWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update workflow
description: 'Update the properties of a workflow object. Only the properties listed in the request body table can be updated. To update any other workflow properties, see workflow: createNewVersion.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-update?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_UpdateWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete workflow
description: 'Delete a workflow object and its associated tasks, taskProcessingResults and versions. The deleted workflow is sent to the deleted workflows container. You can restore a deleted workflow and its associated objects within 30 days of deletion.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-delete?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_DeleteWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/administrationScopeTargets':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.workflow_ListAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/administrationScopeTargets/{directoryObject-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/administrationScopeTargets/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.administrationScopeTarget_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/createdBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get createdBy from identityGovernance
description: The user who created the workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetCreatedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/createdBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.createdBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.createdBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/createdBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.createdBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/createdBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.createdBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/executionScope':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get executionScope from identityGovernance
description: The list of users that meet the workflowExecutionConditions of a workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow_ListExecutionScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.userProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/executionScope/{userProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get executionScope from identityGovernance
description: The list of users that meet the workflowExecutionConditions of a workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetExecutionScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/executionScope/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.executionScope_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/lastModifiedBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lastModifiedBy from identityGovernance
description: The unique identifier of the Microsoft Entra identity that last modified the workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetLastModifiedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/lastModifiedBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.lastModifiedBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.lastModifiedBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/lastModifiedBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.lastModifiedBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/lastModifiedBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.lastModifiedBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.activate':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action activate
description: 'Run a workflow object on-demand. You can run any workflow on-demand, including scheduled workflows. Workflows created from the ''Real-time employee termination'' template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-activate?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_activate
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
subjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.activateWithScope':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action activateWithScope
description: 'Run a workflow object on-demand with a specific scope. You can run any workflow on-demand, including scheduled workflows. Workflows created from the ''Real-time employee termination'' template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-activatewithscope?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_activateGraphWPreScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
scope:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.activationScope'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.cancelProcessing':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action cancelProcessing
description: Cancel one or more workflow runs that are currently in queued or inProgress status. Currently limited to canceling one run per request.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-cancelprocessing?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_cancelProcessing
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
scope:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.cancelScope'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.clearQuarantine':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action clearQuarantine
description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_clearQuarantine
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.createNewVersion':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action createNewVersion
description: Create a new version of the workflow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-createnewversion?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_createNewVersion
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
workflow:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.previewTaskFailures':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action previewTaskFailures
description: 'Validate the tasks configured in a workflow to check for configuration errors. This action identifies any tasks that would fail during execution, allowing you to fix issues before running the workflow. Returns an empty collection if no task failures are detected.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-previewtaskfailures?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_previewTaskFailure
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.previewFailedTask'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.previewWorkflow':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action previewWorkflow
description: 'Run a workflow in preview mode for selected directory objects without affecting production users. This action triggers workflow processing in preview mode, and results can be retrieved by using the List userProcessingResults operation with $filter=workflowExecutionType eq ''previewMode''.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-previewworkflow?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_previewWorkflow
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
subjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/microsoft.graph.identityGovernance.restore':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action restore
description: Restore a deleted workflow object. You can only restore a workflow that was deleted within the last 30 days before Microsoft Entra ID automatically permanently deletes it.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-restore?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_restore
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/previewScope':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get previewScope from identityGovernance
description: The preview scope for the workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow_ListPreviewScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/previewScope/{directoryObject-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get previewScope from identityGovernance
description: The preview scope for the workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetPreviewScope
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/previewScope/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.previewScope_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List runs
description: Get a list of run objects and their properties for a workflow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-list-runs?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_ListRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get run
description: Read the properties and relationships of a run object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-run-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_GetRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/reprocessedRuns':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.workflow.run_ListReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/reprocessedRuns/{run-id1}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.workflow.run_GetReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: run-id1
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/reprocessedRuns/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.reprocessedRun_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List taskProcessingResults (from a run)
description: Get the taskProcessingResult resources for a run.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-run-list-taskprocessingresults?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.run_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The related taskProcessingResults.
operationId: identityGovernance.lifecycleWorkflow.workflow.run_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List userProcessingResults
description: Get user processing results of a workflow run object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-run-list-userprocessingresults?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.run_ListUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $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.identityGovernance.userProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get userProcessingResult
description: Get a userProcessingResult for a run.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-userprocessingresult-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.run_GetUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_ListReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/{run-id1}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_GetReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: run-id1
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.reprocessedRun_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the user targeted for the taskProcessingResult.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List taskProcessingResults (for a user)
description: Get the task processing result from a userProcessingResult either directly or through a run.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-userprocessingresult-list-taskprocessingresults?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The associated individual task execution.
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/{run-id}/userProcessingResults/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
operationId: identityGovernance.lifecycleWorkflow.workflow.run.userProcessingResult_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.run_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/runs/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
description: 'Get a runSummary for run objects over a specified time period. Because the number of runs returned by the list API call can be overwhelming, this summary allows administrators to get a quick overview based on counts.'
operationId: identityGovernance.lifecycleWorkflow.workflow.run_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.runSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List taskReports
description: Get a list of the taskReport objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-list-taskreports?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_ListTaskReport
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.taskReportCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskReports from identityGovernance
description: Represents the aggregation of task execution data for tasks within a workflow object.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetTaskReport
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskReport'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: 'The related lifecycle workflow task.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskDefinition':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskDefinition from identityGovernance
description: 'The taskDefinition associated with the related lifecycle workflow task.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport_GetTaskDefinition
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List taskProcessingResult (for a taskReport)
description: Get the task processing result resources from the taskReport.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskreport-list-taskprocessingresults?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The related lifecycle workflow taskProcessingResults.
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/{taskReport-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: taskReport-id
in: path
description: The unique identifier of taskReport
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskReport
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/taskReports/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
description: 'Get a taskReportSummary for a taskReport. This API provides a summary of task processing results for a specified time period. Because the volume of task processing results and task reports returned by the List API calls can be overwhelming, this summary allows the administrator to get a quick overview based on counts.'
operationId: identityGovernance.lifecycleWorkflow.workflow.taskReport_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskReportSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List tasks (in Lifecycle Workflows)
description: Retrieve the details of the built-in task objects in a workflow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-list-task?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_ListTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.taskCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Create new navigation property to tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.workflow_CreateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task
description: Get a specific task from a workflow or workflowVersion.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-task-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update the navigation property tasks in identityGovernance
operationId: identityGovernance.lifecycleWorkflow.workflow_UpdateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.workflow_DeleteTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.workflow.task_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.workflow.task_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/{task-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.task.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/tasks/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.task_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List userProcessingResults
description: Get the userProcessingResult resources for a workflow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-list-userprocessingresults?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_ListUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.userProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get userProcessingResults from identityGovernance
description: Per-user workflow execution results.
operationId: identityGovernance.lifecycleWorkflow.workflow_GetUserProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_ListReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.runCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/{run-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get reprocessedRuns from identityGovernance
description: The related reprocessed workflow run.
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_GetReprocessedRun
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: run-id
in: path
description: The unique identifier of run
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: run
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/reprocessedRuns/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.reprocessedRun_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the user targeted for the taskProcessingResult.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List taskProcessingResults (for a user)
description: Get the task processing result from a userProcessingResult either directly or through a run.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-userprocessingresult-list-taskprocessingresults?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The associated individual task execution.
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/{userProcessingResult-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: userProcessingResult-id
in: path
description: The unique identifier of userProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/userProcessingResults/microsoft.graph.identityGovernance.summary(startDateTime={startDateTime},endDateTime={endDateTime})':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke function summary
operationId: identityGovernance.lifecycleWorkflow.workflow.userProcessingResult_summary
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: startDateTime
in: path
description: 'Usage: startDateTime={startDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
- name: endDateTime
in: path
description: 'Usage: endDateTime={endDateTime}'
required: true
style: simple
schema:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userSummary'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List workflowVersions
description: Get a list of the workflowVersion objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-list-versions?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_ListVersion
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $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.identityGovernance.workflowVersionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get workflowVersion
description: Read the properties and relationships of a workflowVersion object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflowversion-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow_GetVersion
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/administrationScopeTargets':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.workflow.version_ListAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/administrationScopeTargets/{directoryObject-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get administrationScopeTargets from identityGovernance
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
operationId: identityGovernance.lifecycleWorkflow.workflow.version_GetAdministrationScopeTarget
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/administrationScopeTargets/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version.administrationScopeTarget_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get createdBy from identityGovernance
description: The user who created the workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow.version_GetCreatedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.createdBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.version.createdBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.createdBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/createdBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version.createdBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get lastModifiedBy from identityGovernance
description: The unique identifier of the Microsoft Entra identity that last modified the workflow.
operationId: identityGovernance.lifecycleWorkflow.workflow.version_GetLastModifiedGraphBPre
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.lastModifiedBy_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.version.lastModifiedBy_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.lastModifiedBy_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/lastModifiedBy/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version.lastModifiedBy.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List tasks (in a workflowVersion)
description: Get a list of task objects in a workflowVersion.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflowversion-list-tasks?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.version_ListTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $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.identityGovernance.taskCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Create new navigation property to tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.workflow.version_CreateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task
description: Get a specific task from a workflow or workflowVersion.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-task-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.version_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update the navigation property tasks in identityGovernance
operationId: identityGovernance.lifecycleWorkflow.workflow.version_UpdateTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Delete navigation property tasks for identityGovernance
operationId: identityGovernance.lifecycleWorkflow.workflow.version_DeleteTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task_ListTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task_GetTaskProcessingResult
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult_resume
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult_GetSubject
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult_GetTask
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/{task-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task.taskProcessingResult_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/{workflowVersion-versionNumber}/tasks/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version.task_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- name: workflowVersion-versionNumber
in: path
description: The unique identifier of workflowVersion
required: true
style: simple
schema:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
x-ms-docs-key-type: workflowVersion
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/versions/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow.version_GetCount
parameters:
- name: workflow-id
in: path
description: The unique identifier of workflow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/workflows/$count:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflow_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/workflowTemplates:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: List workflowTemplates
description: Get a list of the workflowTemplate objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-list-workflowtemplates?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_ListWorkflowTemplate
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.identityGovernance.workflowTemplateCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get workflowTemplate
description: Read the properties and relationships of a workflowTemplate object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-workflowtemplate-get?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow_GetWorkflowTemplate
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get tasks from identityGovernance
description: Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate_ListTask
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- $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.identityGovernance.taskCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get tasks from identityGovernance
description: Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate_GetTask
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task_ListTaskProcessingResult
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $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.identityGovernance.taskProcessingResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get taskProcessingResults from identityGovernance
description: The result of processing the task.
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task_GetTaskProcessingResult
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/microsoft.graph.identityGovernance.resume':
post:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Invoke action resume
description: 'Resume a taskProcessingResult that''s inProgress. In the default case, an Azure Logic Apps system-assigned managed identity calls this API. For more information, see Lifecycle Workflows extensibility approach.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitygovernance-taskprocessingresult-resume?view=graph-rest-1.0
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult_resume
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
source:
type: string
nullable: true
type:
type: string
nullable: true
data:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionCallbackData'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get subject from identityGovernance
description: 'The unique identifier of the Microsoft Entra user targeted for the task execution.Supports $filter(eq, ne) and $expand.'
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult_GetSubject
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/mailboxSettings':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult.subject_GetMailboxSetting
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Update property mailboxSettings value.
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult.subject_UpdateMailboxSetting
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult.subject_ListServiceProvisioningError
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/subject/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult.subject.ServiceProvisioningError_GetCount
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/{taskProcessingResult-id}/task':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get task from identityGovernance
description: The related workflow task
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult_GetTask
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- name: taskProcessingResult-id
in: path
description: The unique identifier of taskProcessingResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: taskProcessingResult
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/{task-id}/taskProcessingResults/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task.taskProcessingResult_GetCount
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- name: task-id
in: path
description: The unique identifier of task
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: task
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/lifecycleWorkflows/workflowTemplates/{workflowTemplate-id}/tasks/$count':
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate.task_GetCount
parameters:
- name: workflowTemplate-id
in: path
description: The unique identifier of workflowTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: workflowTemplate
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/lifecycleWorkflows/workflowTemplates/$count:
get:
tags:
- identityGovernance.lifecycleWorkflowsContainer
summary: Get the number of the resource
operationId: identityGovernance.lifecycleWorkflow.workflowTemplate_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/privilegedAccess:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccess from identityGovernance
operationId: identityGovernance_GetPrivilegedAccess
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property privilegedAccess in identityGovernance
operationId: identityGovernance_UpdatePrivilegedAccess
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property privilegedAccess for identityGovernance
operationId: identityGovernance_DeletePrivilegedAccess
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: A group that's governed through Privileged Identity Management (PIM).
operationId: identityGovernance.privilegedAccess_GetGroup
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property group in identityGovernance
operationId: identityGovernance.privilegedAccess_UpdateGroup
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property group for identityGovernance
operationId: identityGovernance.privilegedAccess_DeleteGroup
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/assignmentApprovals:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get assignmentApprovals from identityGovernance
operationId: identityGovernance.privilegedAccess.group_ListAssignmentApproval
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.approvalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create new navigation property to assignmentApprovals for identityGovernance
operationId: identityGovernance.privilegedAccess.group_CreateAssignmentApproval
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentApprovals/{approval-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get assignmentApprovals from identityGovernance
operationId: identityGovernance.privilegedAccess.group_GetAssignmentApproval
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property assignmentApprovals in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateAssignmentApproval
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approval'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property assignmentApprovals for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteAssignmentApproval
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentApprovals/{approval-id}/stages':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get stages from identityGovernance
description: A collection of stages in the approval decision.
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_ListStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- $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.approvalStageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create new navigation property to stages for identityGovernance
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_CreateStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentApprovals/{approval-id}/stages/{approvalStage-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get stages from identityGovernance
description: A collection of stages in the approval decision.
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_GetStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property stages in identityGovernance
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_UpdateStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property stages for identityGovernance
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_DeleteStage
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- name: approvalStage-id
in: path
description: The unique identifier of approvalStage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvalStage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentApprovals/{approval-id}/stages/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentApproval.stage_GetCount
parameters:
- name: approval-id
in: path
description: The unique identifier of approval
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approval
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/privilegedAccess/group/assignmentApprovals/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentApprovals/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: 'In Microsoft Entra entitlement management, return a collection of access package assignment approvals. The objects returned are those that are in scope for approval by the calling user. In PIM for Groups, return a collection of assignment approvals. The objects returned are those that are in scope for approval by the calling user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approval-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.assignmentApproval_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.approvalFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of approval
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/privilegedAccess/group/assignmentScheduleInstances:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: List assignmentScheduleInstances
description: Get a list of the privilegedAccessGroupAssignmentScheduleInstance objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-list-assignmentscheduleinstances?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_ListAssignmentScheduleInstance
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.privilegedAccessGroupAssignmentScheduleInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create new navigation property to assignmentScheduleInstances for identityGovernance
operationId: identityGovernance.privilegedAccess.group_CreateAssignmentScheduleInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/{privilegedAccessGroupAssignmentScheduleInstance-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccessGroupAssignmentScheduleInstance
description: Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleInstance object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentscheduleinstance-get?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_GetAssignmentScheduleInstance
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property assignmentScheduleInstances in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateAssignmentScheduleInstance
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property assignmentScheduleInstances for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteAssignmentScheduleInstance
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/{privilegedAccessGroupAssignmentScheduleInstance-id}/activatedUsing':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get activatedUsing from identityGovernance
description: 'When the request activates a membership or ownership in PIM for Groups, this object represents the eligibility request for the group. Otherwise, it is null.'
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance_GetActivatedUsing
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/{privilegedAccessGroupAssignmentScheduleInstance-id}/group':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: References the group that is the scope of the membership or ownership assignment through PIM for Groups. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance_GetGroup
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/{privilegedAccessGroupAssignmentScheduleInstance-id}/group/serviceProvisioningErrors':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance.group_ListServiceProvisioningError
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/{privilegedAccessGroupAssignmentScheduleInstance-id}/group/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance.group.ServiceProvisioningError_GetCount
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/{privilegedAccessGroupAssignmentScheduleInstance-id}/principal':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get principal from identityGovernance
description: References the principal that's in the scope of the membership or ownership assignment request through the group that's governed by PIM. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance_GetPrincipal
parameters:
- name: privilegedAccessGroupAssignmentScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: 'In PIM for Groups, retrieve the schedule instances for membership or ownership assignments for the calling principal to groups that are governed by PIM.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentscheduleinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleInstance_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.assignmentScheduleInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of privilegedAccessGroupAssignmentScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/privilegedAccess/group/assignmentScheduleRequests:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: List assignmentScheduleRequests
description: Get a list of the privilegedAccessGroupAssignmentScheduleRequest objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-list-assignmentschedulerequests?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_ListAssignmentScheduleRequest
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.privilegedAccessGroupAssignmentScheduleRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create assignmentScheduleRequest
description: Create a new privilegedAccessGroupAssignmentScheduleRequest object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-post-assignmentschedulerequests?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_CreateAssignmentScheduleRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccessGroupAssignmentScheduleRequest
description: Read the properties and relationships of a privilegedAccessGroupAssignmentScheduleRequest object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentschedulerequest-get?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_GetAssignmentScheduleRequest
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property assignmentScheduleRequests in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateAssignmentScheduleRequest
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property assignmentScheduleRequests for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteAssignmentScheduleRequest
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/activatedUsing':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get activatedUsing from identityGovernance
description: 'When the request activates a membership or ownership assignment in PIM for Groups, this object represents the eligibility policy for the group. Otherwise, it is null. Supports $expand.'
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_GetActivatedUsing
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/group':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: 'References the group that is the scope of the membership or ownership assignment request through PIM for Groups. Supports $expand and $select nested in $expand for select properties like id, displayName, and mail.'
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_GetGroup
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/group/serviceProvisioningErrors':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest.group_ListServiceProvisioningError
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/group/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest.group.ServiceProvisioningError_GetCount
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/microsoft.graph.cancel':
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke action cancel
description: Cancel an access assignment request to a group whose membership and ownership are governed by PIM.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentschedulerequest-cancel?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_cancel
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/principal':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get principal from identityGovernance
description: References the principal that's in the scope of this membership or ownership assignment request through the group that's governed by PIM. Supports $expand and $select nested in $expand for id only.
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_GetPrincipal
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/{privilegedAccessGroupAssignmentScheduleRequest-id}/targetSchedule':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get targetSchedule from identityGovernance
description: Schedule created by this request. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_GetTargetSchedule
parameters:
- name: privilegedAccessGroupAssignmentScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: 'In PIM for Groups, retrieve the requests for membership or ownership assignments for the calling principal to groups that are governed by PIM.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentschedulerequest-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.assignmentScheduleRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.assignmentScheduleRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of privilegedAccessGroupAssignmentScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/privilegedAccess/group/assignmentSchedules:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: List assignmentSchedules
description: Get a list of the privilegedAccessGroupAssignmentSchedule objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-list-assignmentschedules?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_ListAssignmentSchedule
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.privilegedAccessGroupAssignmentScheduleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create new navigation property to assignmentSchedules for identityGovernance
operationId: identityGovernance.privilegedAccess.group_CreateAssignmentSchedule
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentSchedules/{privilegedAccessGroupAssignmentSchedule-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccessGroupAssignmentSchedule
description: Read the properties and relationships of a privilegedAccessGroupAssignmentSchedule object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentschedule-get?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_GetAssignmentSchedule
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property assignmentSchedules in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateAssignmentSchedule
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property assignmentSchedules for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteAssignmentSchedule
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentSchedules/{privilegedAccessGroupAssignmentSchedule-id}/activatedUsing':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get activatedUsing from identityGovernance
description: 'When the request activates an ownership or membership assignment in PIM for Groups, this object represents the eligibility relationship. Otherwise, it''s null. Supports $expand.'
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule_GetActivatedUsing
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentSchedules/{privilegedAccessGroupAssignmentSchedule-id}/group':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: 'References the group that is the scope of the membership or ownership assignment through PIM for Groups. Supports $expand and $select nested in $expand for select properties like id, displayName, and mail.'
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule_GetGroup
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/assignmentSchedules/{privilegedAccessGroupAssignmentSchedule-id}/group/serviceProvisioningErrors':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule.group_ListServiceProvisioningError
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/privilegedAccess/group/assignmentSchedules/{privilegedAccessGroupAssignmentSchedule-id}/group/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule.group.ServiceProvisioningError_GetCount
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentSchedules/{privilegedAccessGroupAssignmentSchedule-id}/principal':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get principal from identityGovernance
description: References the principal that's in the scope of this membership or ownership assignment request to the group that's governed through PIM. Supports $expand and $select nested in $expand for id only.
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule_GetPrincipal
parameters:
- name: privilegedAccessGroupAssignmentSchedule-id
in: path
description: The unique identifier of privilegedAccessGroupAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/assignmentSchedules/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/assignmentSchedules/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: 'In PIM for Groups, retrieve the schedules for membership or ownership assignments for the calling principal to groups that are governed by PIM.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupassignmentschedule-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.assignmentSchedule_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.assignmentScheduleFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of privilegedAccessGroupAssignmentSchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: List eligibilityScheduleInstances
description: Get a list of the privilegedAccessGroupEligibilityScheduleInstance objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-list-eligibilityscheduleinstances?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_ListEligibilityScheduleInstance
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.privilegedAccessGroupEligibilityScheduleInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create new navigation property to eligibilityScheduleInstances for identityGovernance
operationId: identityGovernance.privilegedAccess.group_CreateEligibilityScheduleInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/{privilegedAccessGroupEligibilityScheduleInstance-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccessGroupEligibilityScheduleInstance
description: Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleInstance object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityscheduleinstance-get?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_GetEligibilityScheduleInstance
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property eligibilityScheduleInstances in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateEligibilityScheduleInstance
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property eligibilityScheduleInstances for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteEligibilityScheduleInstance
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/{privilegedAccessGroupEligibilityScheduleInstance-id}/group':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: References the group that is the scope of the membership or ownership eligibility through PIM for Groups. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleInstance_GetGroup
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/{privilegedAccessGroupEligibilityScheduleInstance-id}/group/serviceProvisioningErrors':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleInstance.group_ListServiceProvisioningError
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/{privilegedAccessGroupEligibilityScheduleInstance-id}/group/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleInstance.group.ServiceProvisioningError_GetCount
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/{privilegedAccessGroupEligibilityScheduleInstance-id}/principal':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get principal from identityGovernance
description: References the principal that's in the scope of the membership or ownership eligibility request through the group that's governed by PIM. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleInstance_GetPrincipal
parameters:
- name: privilegedAccessGroupEligibilityScheduleInstance-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleInstance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: Return instances of membership and ownership eligibility schedules for the calling principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityscheduleinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleInstance_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.eligibilityScheduleInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of privilegedAccessGroupEligibilityScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: List eligibilityScheduleRequests
description: Get a list of the privilegedAccessGroupEligibilityScheduleRequest objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-list-eligibilityschedulerequests?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_ListEligibilityScheduleRequest
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.privilegedAccessGroupEligibilityScheduleRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create eligibilityScheduleRequest
description: Create a new privilegedAccessGroupEligibilityScheduleRequest object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-post-eligibilityschedulerequests?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_CreateEligibilityScheduleRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccessGroupEligibilityScheduleRequest
description: Read the properties and relationships of a privilegedAccessGroupEligibilityScheduleRequest object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityschedulerequest-get?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_GetEligibilityScheduleRequest
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property eligibilityScheduleRequests in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateEligibilityScheduleRequest
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property eligibilityScheduleRequests for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteEligibilityScheduleRequest
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}/group':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: 'References the group that is the scope of the membership or ownership eligibility request through PIM for Groups. Supports $expand and $select nested in $expand for select properties like id, displayName, and mail.'
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest_GetGroup
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}/group/serviceProvisioningErrors':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest.group_ListServiceProvisioningError
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}/group/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest.group.ServiceProvisioningError_GetCount
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}/microsoft.graph.cancel':
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke action cancel
description: Cancel an eligibility assignment request to a group whose membership and ownership are governed by PIM.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityschedulerequest-cancel?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest_cancel
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}/principal':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get principal from identityGovernance
description: References the principal that's in the scope of the membership or ownership eligibility request through the group that's governed by PIM. Supports $expand and $select nested in $expand for id only.
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest_GetPrincipal
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/{privilegedAccessGroupEligibilityScheduleRequest-id}/targetSchedule':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get targetSchedule from identityGovernance
description: Schedule created by this request.
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest_GetTargetSchedule
parameters:
- name: privilegedAccessGroupEligibilityScheduleRequest-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: 'In PIM for Groups, retrieve the requests for membership or ownership eligibilities for the calling principal to groups that are governed by PIM.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityschedulerequest-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.eligibilityScheduleRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.eligibilityScheduleRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of privilegedAccessGroupEligibilityScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/privilegedAccess/group/eligibilitySchedules:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: List eligibilitySchedules
description: Get a list of the privilegedAccessGroupEligibilitySchedule objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroup-list-eligibilityschedules?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_ListEligibilitySchedule
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.privilegedAccessGroupEligibilityScheduleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.privilegedAccessRoot
summary: Create new navigation property to eligibilitySchedules for identityGovernance
operationId: identityGovernance.privilegedAccess.group_CreateEligibilitySchedule
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilitySchedules/{privilegedAccessGroupEligibilitySchedule-id}':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get privilegedAccessGroupEligibilitySchedule
description: Read the properties and relationships of a privilegedAccessGroupEligibilitySchedule object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityschedule-get?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group_GetEligibilitySchedule
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.privilegedAccessRoot
summary: Update the navigation property eligibilitySchedules in identityGovernance
operationId: identityGovernance.privilegedAccess.group_UpdateEligibilitySchedule
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.privilegedAccessRoot
summary: Delete navigation property eligibilitySchedules for identityGovernance
operationId: identityGovernance.privilegedAccess.group_DeleteEligibilitySchedule
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilitySchedules/{privilegedAccessGroupEligibilitySchedule-id}/group':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get group from identityGovernance
description: References the group that is the scope of the membership or ownership eligibility through PIM for Groups. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.eligibilitySchedule_GetGroup
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/privilegedAccess/group/eligibilitySchedules/{privilegedAccessGroupEligibilitySchedule-id}/group/serviceProvisioningErrors':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get serviceProvisioningErrors property value
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
operationId: identityGovernance.privilegedAccess.group.eligibilitySchedule.group_ListServiceProvisioningError
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
- $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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/identityGovernance/privilegedAccess/group/eligibilitySchedules/{privilegedAccessGroupEligibilitySchedule-id}/group/serviceProvisioningErrors/$count':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.eligibilitySchedule.group.ServiceProvisioningError_GetCount
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/eligibilitySchedules/{privilegedAccessGroupEligibilitySchedule-id}/principal':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get principal from identityGovernance
description: References the principal that's in the scope of this membership or ownership eligibility request to the group that's governed by PIM. Supports $expand.
operationId: identityGovernance.privilegedAccess.group.eligibilitySchedule_GetPrincipal
parameters:
- name: privilegedAccessGroupEligibilitySchedule-id
in: path
description: The unique identifier of privilegedAccessGroupEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: privilegedAccessGroupEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/privilegedAccess/group/eligibilitySchedules/$count:
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Get the number of the resource
operationId: identityGovernance.privilegedAccess.group.eligibilitySchedule_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/privilegedAccess/group/eligibilitySchedules/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- identityGovernance.privilegedAccessRoot
summary: Invoke function filterByCurrentUser
description: Retrieve schedules of membership and ownership eligibility requests for the calling principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/privilegedaccessgroupeligibilityschedule-filterbycurrentuser?view=graph-rest-1.0
operationId: identityGovernance.privilegedAccess.group.eligibilitySchedule_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.eligibilityScheduleFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of privilegedAccessGroupEligibilitySchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identityGovernance/termsOfUse:
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get termsOfUse from identityGovernance
operationId: identityGovernance_GetTermsGraphOPreUse
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.termsOfUseContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property termsOfUse in identityGovernance
operationId: identityGovernance_UpdateTermsGraphOPreUse
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.termsOfUseContainer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.termsOfUseContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property termsOfUse for identityGovernance
operationId: identityGovernance_DeleteTermsGraphOPreUse
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/termsOfUse/agreementAcceptances:
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get agreementAcceptances from identityGovernance
description: Represents the current status of a user's response to a company's customizable terms of use agreement.
operationId: identityGovernance.termsGraphOPreUse_ListAgreementAcceptance
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.agreementAcceptanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create new navigation property to agreementAcceptances for identityGovernance
operationId: identityGovernance.termsGraphOPreUse_CreateAgreementAcceptance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreementAcceptances/{agreementAcceptance-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get agreementAcceptances from identityGovernance
description: Represents the current status of a user's response to a company's customizable terms of use agreement.
operationId: identityGovernance.termsGraphOPreUse_GetAgreementAcceptance
parameters:
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property agreementAcceptances in identityGovernance
operationId: identityGovernance.termsGraphOPreUse_UpdateAgreementAcceptance
parameters:
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property agreementAcceptances for identityGovernance
operationId: identityGovernance.termsGraphOPreUse_DeleteAgreementAcceptance
parameters:
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityGovernance/termsOfUse/agreementAcceptances/$count:
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreementAcceptance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/termsOfUse/agreements:
get:
tags:
- identityGovernance.termsOfUseContainer
summary: List agreements
description: Retrieve a list of agreement objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/termsofusecontainer-list-agreements?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse_ListAgreement
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.agreementCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create agreement
description: Create a new agreement object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/termsofusecontainer-post-agreements?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse_CreateAgreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get agreement
description: Retrieve the properties and relationships of an agreement object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreement-get?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse_GetAgreement
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update agreement
description: Update the properties of an agreement object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreement-update?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse_UpdateAgreement
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreement'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete agreement
description: Delete an agreement object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreement-delete?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse_DeleteAgreement
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: List acceptances
description: Get the details about the acceptance records for a specific agreement.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreement-list-acceptances?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse.agreement_ListAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $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.agreementAcceptanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create new navigation property to acceptances for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_CreateAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get acceptances from identityGovernance
description: Read-only. Information about acceptances of this agreement.
operationId: identityGovernance.termsGraphOPreUse.agreement_GetAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property acceptances in identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_UpdateAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property acceptances for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_DeleteAcceptance
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances/$count':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreement.acceptance_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get agreementFile
description: 'Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreementfile-get?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse.agreement_GetFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property file in identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_UpdateFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property file for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_DeleteFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get localizations from identityGovernance
description: The localized version of the terms of use agreement files attached to the agreement.
operationId: identityGovernance.termsGraphOPreUse.agreement.file_ListLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $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.agreementFileLocalizationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create new navigation property to localizations for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file_CreateLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get localizations from identityGovernance
description: The localized version of the terms of use agreement files attached to the agreement.
operationId: identityGovernance.termsGraphOPreUse.agreement.file_GetLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property localizations in identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file_UpdateLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property localizations for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file_DeleteLocalization
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get versions from identityGovernance
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization_ListVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $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.agreementFileVersionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create new navigation property to versions for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization_CreateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get versions from identityGovernance
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization_GetVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property versions in identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization_UpdateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property versions for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization_DeleteVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/$count':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization.version_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/$count':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreement.file.localization_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/termsOfUse/agreements/{agreement-id}/files':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get files from identityGovernance
description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
operationId: identityGovernance.termsGraphOPreUse.agreement_ListFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $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.agreementFileLocalizationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create agreementFileLocalization
description: Create a new localized agreement file.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agreement-post-files?view=graph-rest-1.0
operationId: identityGovernance.termsGraphOPreUse.agreement_CreateFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get files from identityGovernance
description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
operationId: identityGovernance.termsGraphOPreUse.agreement_GetFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property files in identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_UpdateFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property files for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement_DeleteFile
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get versions from identityGovernance
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: identityGovernance.termsGraphOPreUse.agreement.file_ListVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $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.agreementFileVersionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.termsOfUseContainer
summary: Create new navigation property to versions for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file_CreateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get versions from identityGovernance
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
operationId: identityGovernance.termsGraphOPreUse.agreement.file_GetVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityGovernance.termsOfUseContainer
summary: Update the navigation property versions in identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file_UpdateVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityGovernance.termsOfUseContainer
summary: Delete navigation property versions for identityGovernance
operationId: identityGovernance.termsGraphOPreUse.agreement.file_DeleteVersion
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- name: agreementFileVersion-id
in: path
description: The unique identifier of agreementFileVersion
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileVersion
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/$count':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreement.file.version_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- name: agreementFileLocalization-id
in: path
description: The unique identifier of agreementFileLocalization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementFileLocalization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identityGovernance/termsOfUse/agreements/{agreement-id}/files/$count':
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreement.file_GetCount
parameters:
- name: agreement-id
in: path
description: The unique identifier of agreement
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreement
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityGovernance/termsOfUse/agreements/$count:
get:
tags:
- identityGovernance.termsOfUseContainer
summary: Get the number of the resource
operationId: identityGovernance.termsGraphOPreUse.agreement_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/directory:
get:
tags:
- roleManagement.rbacApplication
summary: Get directory from roleManagement
operationId: roleManagement_GetDirectory
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.rbacApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property directory in roleManagement
operationId: roleManagement_UpdateDirectory
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.rbacApplication'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.rbacApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property directory for roleManagement
operationId: roleManagement_DeleteDirectory
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/resourceNamespaces:
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceNamespaces from roleManagement
operationId: roleManagement.directory_ListResourceNamespace
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.unifiedRbacResourceNamespaceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to resourceNamespaces for roleManagement
operationId: roleManagement.directory_CreateResourceNamespace
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespace-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceNamespaces from roleManagement
operationId: roleManagement.directory_GetResourceNamespace
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property resourceNamespaces in roleManagement
operationId: roleManagement.directory_UpdateResourceNamespace
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property resourceNamespaces for roleManagement
operationId: roleManagement.directory_DeleteResourceNamespace
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespace-id}/resourceActions':
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceActions from roleManagement
operationId: roleManagement.directory.resourceNamespace_ListResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- $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.unifiedRbacResourceActionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to resourceActions for roleManagement
operationId: roleManagement.directory.resourceNamespace_CreateResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespace-id}/resourceActions/{unifiedRbacResourceAction-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceActions from roleManagement
operationId: roleManagement.directory.resourceNamespace_GetResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: unifiedRbacResourceAction-id
in: path
description: The unique identifier of unifiedRbacResourceAction
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceAction
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property resourceActions in roleManagement
operationId: roleManagement.directory.resourceNamespace_UpdateResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: unifiedRbacResourceAction-id
in: path
description: The unique identifier of unifiedRbacResourceAction
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceAction
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property resourceActions for roleManagement
operationId: roleManagement.directory.resourceNamespace_DeleteResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: unifiedRbacResourceAction-id
in: path
description: The unique identifier of unifiedRbacResourceAction
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceAction
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespace-id}/resourceActions/$count':
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.resourceNamespace.resourceAction_GetCount
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/directory/resourceNamespaces/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.resourceNamespace_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/directory/roleAssignments:
get:
tags:
- roleManagement.rbacApplication
summary: List unifiedRoleAssignments
description: "Get a list of unifiedRoleAssignment objects for the RBAC provider. The following RBAC providers are currently supported:\r\n- directory (Microsoft Entra ID)\r\n- entitlement management (Microsoft Entra entitlement management)"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleassignments?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleAssignment
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.unifiedRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create unifiedRoleAssignment
description: Create a new unifiedRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0
operationId: roleManagement.directory_CreateRoleAssignment
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignments/{unifiedRoleAssignment-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleAssignment
description: Retrieve the properties and relationships of a unifiedRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignment-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleAssignment
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignments in roleManagement
operationId: roleManagement.directory_UpdateRoleAssignment
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete unifiedRoleAssignment
description: Delete a unifiedRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignment-delete?view=graph-rest-1.0
operationId: roleManagement.directory_DeleteRoleAssignment
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignments/{unifiedRoleAssignment-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app specific scope when the assignment scope is app specific. Containment entity. Supports $expand for the entitlement provider only.
operationId: roleManagement.directory.roleAssignment_GetAppScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property appScope in roleManagement
operationId: roleManagement.directory.roleAssignment_UpdateAppScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property appScope for roleManagement
operationId: roleManagement.directory.roleAssignment_DeleteAppScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignments/{unifiedRoleAssignment-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment. Read-only. Supports $expand for the directory provider.
operationId: roleManagement.directory.roleAssignment_GetDirectoryScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignments/{unifiedRoleAssignment-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: Referencing the assigned principal. Read-only. Supports $expand except for the Exchange provider.
operationId: roleManagement.directory.roleAssignment_GetPrincipal
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignments/{unifiedRoleAssignment-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: The roleDefinition the assignment is for. Supports $expand.
operationId: roleManagement.directory.roleAssignment_GetRoleDefinition
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleAssignments/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleAssignment_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/directory/roleAssignmentScheduleInstances:
get:
tags:
- roleManagement.rbacApplication
summary: List roleAssignmentScheduleInstances
description: 'Get the instances of active role assignments in your tenant. The active assignments include those made through assignments and activation requests, and directly through the role assignments API.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleassignmentscheduleinstances?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleAssignmentScheduleInstance
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.unifiedRoleAssignmentScheduleInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleAssignmentScheduleInstances for roleManagement
operationId: roleManagement.directory_CreateRoleAssignmentScheduleInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleAssignmentScheduleInstance
description: Get the instance of an active role assignment.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentscheduleinstance-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleAssignmentScheduleInstance
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignmentScheduleInstances in roleManagement
operationId: roleManagement.directory_UpdateRoleAssignmentScheduleInstance
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignmentScheduleInstances for roleManagement
operationId: roleManagement.directory_DeleteRoleAssignmentScheduleInstance
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/activatedUsing':
get:
tags:
- roleManagement.rbacApplication
summary: Get activatedUsing from roleManagement
description: 'If the request is from an eligible administrator to activate a role, this parameter shows the related eligible assignment for that activation. Otherwise, it''s null. Supports $expand and $select nested in $expand.'
operationId: roleManagement.directory.roleAssignmentScheduleInstance_GetActivatedUsing
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
operationId: roleManagement.directory.roleAssignmentScheduleInstance_GetAppScope
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment or role eligibility. Read-only.
operationId: roleManagement.directory.roleAssignmentScheduleInstance_GetDirectoryScope
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or role eligibility through the request.
operationId: roleManagement.directory.roleAssignmentScheduleInstance_GetPrincipal
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.directory.roleAssignmentScheduleInstance_GetRoleDefinition
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleAssignmentScheduleInstances/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleAssignmentScheduleInstance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/directory/roleAssignmentScheduleInstances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Get the instances of active role assignments for the calling principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentscheduleinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.directory.roleAssignmentScheduleInstance_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleAssignmentScheduleInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleAssignmentScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/directory/roleAssignmentScheduleRequests:
get:
tags:
- roleManagement.rbacApplication
summary: List roleAssignmentScheduleRequests
description: 'Retrieve the requests for active role assignments to principals. The active assignments include those made through assignments and activation requests, and directly through the role assignments API. The role assignments can be permanently active with or without an expiry date, or temporarily active after user activation of eligible assignments.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleassignmentschedulerequests?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleAssignmentScheduleRequest
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.unifiedRoleAssignmentScheduleRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create roleAssignmentScheduleRequests
description: 'In PIM, carry out the following operations through the unifiedRoleAssignmentScheduleRequest object: To call this API to update, renew, and extend assignments for yourself, you must have multifactor authentication (MFA) enforced, and running the query in a session in which they were challenged for MFA. See Enable per-user Microsoft Entra multifactor authentication to secure sign-in events.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-post-roleassignmentschedulerequests?view=graph-rest-1.0
operationId: roleManagement.directory_CreateRoleAssignmentScheduleRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleAssignmentScheduleRequest
description: 'In PIM, read the details of a request for an active and persistent role assignment made through the unifiedRoleAssignmentScheduleRequest object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedulerequest-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleAssignmentScheduleRequest
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignmentScheduleRequests in roleManagement
operationId: roleManagement.directory_UpdateRoleAssignmentScheduleRequest
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignmentScheduleRequests for roleManagement
operationId: roleManagement.directory_DeleteRoleAssignmentScheduleRequest
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/activatedUsing':
get:
tags:
- roleManagement.rbacApplication
summary: Get activatedUsing from roleManagement
description: 'If the request is from an eligible administrator to activate a role, this parameter will show the related eligible assignment for that activation. Otherwise, it''s null. Supports $expand and $select nested in $expand.'
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetActivatedUsing
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the assignment is scoped to an app. Nullable. Supports $expand.
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetAppScope
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment. Read-only. Supports $expand.
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetDirectoryScope
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/microsoft.graph.cancel':
post:
tags:
- roleManagement.rbacApplication
summary: Invoke action cancel
description: 'Immediately cancel a unifiedRoleAssignmentScheduleRequest object that is in a Granted status, and have the system automatically delete the canceled request after 30 days. After calling this action, the status of the canceled unifiedRoleAssignmentScheduleRequest changes to Canceled.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedulerequest-cancel?view=graph-rest-1.0
operationId: roleManagement.directory.roleAssignmentScheduleRequest_cancel
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment through the request. Supports $expand and $select nested in $expand for id only.
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetPrincipal
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the unifiedRoleDefinition object that is referenced through the roleDefinitionId property. Supports $expand and $select nested in $expand.
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetRoleDefinition
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/targetSchedule':
get:
tags:
- roleManagement.rbacApplication
summary: Get targetSchedule from roleManagement
description: The schedule for an eligible role assignment that is referenced through the targetScheduleId property. Supports $expand and $select nested in $expand.
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetTargetSchedule
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleAssignmentScheduleRequests/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleAssignmentScheduleRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/directory/roleAssignmentScheduleRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: 'In PIM, retrieve the requests for active role assignments for a particular principal. The principal can be the creator or approver of the unifiedRoleAssignmentScheduleRequest object, or they can be the target of the assignment.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedulerequest-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.directory.roleAssignmentScheduleRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleAssignmentScheduleRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleAssignmentScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/directory/roleAssignmentSchedules:
get:
tags:
- roleManagement.rbacApplication
summary: List roleAssignmentSchedules
description: Get the schedules for active role assignment operations.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleassignmentschedules?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleAssignmentSchedule
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.unifiedRoleAssignmentScheduleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleAssignmentSchedules for roleManagement
operationId: roleManagement.directory_CreateRoleAssignmentSchedule
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleAssignmentSchedule
description: Retrieve the schedule for an active role assignment operation.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedule-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleAssignmentSchedule
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignmentSchedules in roleManagement
operationId: roleManagement.directory_UpdateRoleAssignmentSchedule
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignmentSchedules for roleManagement
operationId: roleManagement.directory_DeleteRoleAssignmentSchedule
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/activatedUsing':
get:
tags:
- roleManagement.rbacApplication
summary: Get activatedUsing from roleManagement
description: 'If the request is from an eligible administrator to activate a role, this parameter shows the related eligible assignment for that activation. Otherwise, it''s null. Supports $expand.'
operationId: roleManagement.directory.roleAssignmentSchedule_GetActivatedUsing
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.
operationId: roleManagement.directory.roleAssignmentSchedule_GetAppScope
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the role eligibility or assignment. Read-only.
operationId: roleManagement.directory.roleAssignmentSchedule_GetDirectoryScope
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or that's eligible for a role through the request.
operationId: roleManagement.directory.roleAssignmentSchedule_GetPrincipal
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.directory.roleAssignmentSchedule_GetRoleDefinition
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleAssignmentSchedules/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleAssignmentSchedule_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/directory/roleAssignmentSchedules/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Retrieve the schedules for active role assignment operations for which the signed-in user is the principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedule-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.directory.roleAssignmentSchedule_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleAssignmentScheduleFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleAssignmentSchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/directory/roleDefinitions:
get:
tags:
- roleManagement.rbacApplication
summary: List roleDefinitions
description: "Get a list of unifiedRoleDefinition objects for the provider. The following RBAC providers are currently supported:\r\n- directory (Microsoft Entra ID)\r\n- entitlement management (Microsoft Entra Entitlement Management)"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roledefinitions?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleDefinition
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.unifiedRoleDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create roleDefinitions
description: Create a new custom unifiedRoleDefinition object. This feature requires a Microsoft Entra ID P1 or P2 license.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-post-roledefinitions?view=graph-rest-1.0
operationId: roleManagement.directory_CreateRoleDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleDefinitions/{unifiedRoleDefinition-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleDefinition
description: 'Read the properties and relationships of a unifiedRoleDefinition object. The following role-based access control (RBAC) providers are currently supported:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroledefinition-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleDefinition
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update unifiedRoleDefinition
description: Update the properties of a unifiedRoleDefinition object. You cannot update built-in roles. This feature requires a Microsoft Entra ID P1 or P2 license.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroledefinition-update?view=graph-rest-1.0
operationId: roleManagement.directory_UpdateRoleDefinition
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete unifiedRoleDefinition
description: Delete a unifiedRoleDefinition object. You can't delete built-in roles. This feature requires a Microsoft Entra ID P1 or P2 license.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroledefinition-delete?view=graph-rest-1.0
operationId: roleManagement.directory_DeleteRoleDefinition
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleDefinitions/{unifiedRoleDefinition-id}/inheritsPermissionsFrom':
get:
tags:
- roleManagement.rbacApplication
summary: Get inheritsPermissionsFrom from roleManagement
description: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.
operationId: roleManagement.directory.roleDefinition_ListInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- $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.unifiedRoleDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to inheritsPermissionsFrom for roleManagement
operationId: roleManagement.directory.roleDefinition_CreateInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleDefinitions/{unifiedRoleDefinition-id}/inheritsPermissionsFrom/{unifiedRoleDefinition-id1}':
get:
tags:
- roleManagement.rbacApplication
summary: Get inheritsPermissionsFrom from roleManagement
description: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.
operationId: roleManagement.directory.roleDefinition_GetInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: unifiedRoleDefinition-id1
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property inheritsPermissionsFrom in roleManagement
operationId: roleManagement.directory.roleDefinition_UpdateInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: unifiedRoleDefinition-id1
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property inheritsPermissionsFrom for roleManagement
operationId: roleManagement.directory.roleDefinition_DeleteInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: unifiedRoleDefinition-id1
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleDefinitions/{unifiedRoleDefinition-id}/inheritsPermissionsFrom/$count':
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleDefinition.inheritsPermissionsFrom_GetCount
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/directory/roleDefinitions/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleDefinition_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/directory/roleEligibilityScheduleInstances:
get:
tags:
- roleManagement.rbacApplication
summary: List roleEligibilityScheduleInstances
description: Get the instances of role eligibilities.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleeligibilityscheduleinstances?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleEligibilityScheduleInstance
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.unifiedRoleEligibilityScheduleInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleEligibilityScheduleInstances for roleManagement
operationId: roleManagement.directory_CreateRoleEligibilityScheduleInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleEligibilityScheduleInstance
description: Get the instance of a role eligibility.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityscheduleinstance-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleEligibilityScheduleInstance
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleEligibilityScheduleInstances in roleManagement
operationId: roleManagement.directory_UpdateRoleEligibilityScheduleInstance
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleEligibilityScheduleInstances for roleManagement
operationId: roleManagement.directory_DeleteRoleEligibilityScheduleInstance
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
operationId: roleManagement.directory.roleEligibilityScheduleInstance_GetAppScope
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment or role eligibility. Read-only.
operationId: roleManagement.directory.roleEligibilityScheduleInstance_GetDirectoryScope
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or role eligibility through the request.
operationId: roleManagement.directory.roleEligibilityScheduleInstance_GetPrincipal
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.directory.roleEligibilityScheduleInstance_GetRoleDefinition
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleEligibilityScheduleInstances/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleEligibilityScheduleInstance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/directory/roleEligibilityScheduleInstances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Get the instances of eligible roles for the calling principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityscheduleinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.directory.roleEligibilityScheduleInstance_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleEligibilityScheduleInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleEligibilityScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/directory/roleEligibilityScheduleRequests:
get:
tags:
- roleManagement.rbacApplication
summary: List roleEligibilityScheduleRequests
description: 'In PIM, retrieve the requests for role eligibilities for principals made through the unifiedRoleEligibilityScheduleRequest object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleeligibilityschedulerequests?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleEligibilityScheduleRequest
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.unifiedRoleEligibilityScheduleRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create roleEligibilityScheduleRequest
description: 'In PIM, request for a role eligibility for a principal through the unifiedRoleEligibilityScheduleRequest object. This operation allows both admins and eligible users to add, revoke, or extend eligible assignments.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-post-roleeligibilityschedulerequests?view=graph-rest-1.0
operationId: roleManagement.directory_CreateRoleEligibilityScheduleRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleEligibilityScheduleRequest
description: 'In PIM, read the details of a request for for a role eligibility request made through the unifiedRoleEligibilityScheduleRequest object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedulerequest-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleEligibilityScheduleRequest
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleEligibilityScheduleRequests in roleManagement
operationId: roleManagement.directory_UpdateRoleEligibilityScheduleRequest
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleEligibilityScheduleRequests for roleManagement
operationId: roleManagement.directory_DeleteRoleEligibilityScheduleRequest
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the role eligibility is scoped to an app. Nullable. Supports $expand.
operationId: roleManagement.directory.roleEligibilityScheduleRequest_GetAppScope
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the role eligibility. Read-only. Supports $expand.
operationId: roleManagement.directory.roleEligibilityScheduleRequest_GetDirectoryScope
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/microsoft.graph.cancel':
post:
tags:
- roleManagement.rbacApplication
summary: Invoke action cancel
description: 'Immediately cancel a unifiedRoleEligibilityScheduleRequest object whose status is Granted and have the system automatically delete the cancelled request after 30 days. After calling this action, the status of the cancelled unifiedRoleEligibilityScheduleRequest changes to Revoked.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedulerequest-cancel?view=graph-rest-1.0
operationId: roleManagement.directory.roleEligibilityScheduleRequest_cancel
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role eligibility through the request. Supports $expand.
operationId: roleManagement.directory.roleEligibilityScheduleRequest_GetPrincipal
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the unifiedRoleDefinition object that is referenced through the roleDefinitionId property. Supports $expand.
operationId: roleManagement.directory.roleEligibilityScheduleRequest_GetRoleDefinition
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/targetSchedule':
get:
tags:
- roleManagement.rbacApplication
summary: Get targetSchedule from roleManagement
description: The schedule for a role eligibility that is referenced through the targetScheduleId property. Supports $expand.
operationId: roleManagement.directory.roleEligibilityScheduleRequest_GetTargetSchedule
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleEligibilityScheduleRequests/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleEligibilityScheduleRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/directory/roleEligibilityScheduleRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: 'In PIM, retrieve the requests for role eligibilities for a particular principal. The principal can be the creator or approver of the unifiedRoleEligibilityScheduleRequest object, or they can be the target of the role eligibility.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedulerequest-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.directory.roleEligibilityScheduleRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleEligibilityScheduleRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleEligibilityScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/directory/roleEligibilitySchedules:
get:
tags:
- roleManagement.rbacApplication
summary: List roleEligibilitySchedules
description: Get the unifiedRoleEligibilitySchedule resources from the roleEligibilitySchedules navigation property.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleeligibilityschedules?view=graph-rest-1.0
operationId: roleManagement.directory_ListRoleEligibilitySchedule
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.unifiedRoleEligibilityScheduleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleEligibilitySchedules for roleManagement
operationId: roleManagement.directory_CreateRoleEligibilitySchedule
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get unifiedRoleEligibilitySchedule
description: Retrieve the schedule for a role eligibility operation.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedule-get?view=graph-rest-1.0
operationId: roleManagement.directory_GetRoleEligibilitySchedule
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleEligibilitySchedules in roleManagement
operationId: roleManagement.directory_UpdateRoleEligibilitySchedule
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleEligibilitySchedules for roleManagement
operationId: roleManagement.directory_DeleteRoleEligibilitySchedule
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.
operationId: roleManagement.directory.roleEligibilitySchedule_GetAppScope
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the role eligibility or assignment. Read-only.
operationId: roleManagement.directory.roleEligibilitySchedule_GetDirectoryScope
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or that's eligible for a role through the request.
operationId: roleManagement.directory.roleEligibilitySchedule_GetPrincipal
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/directory/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.directory.roleEligibilitySchedule_GetRoleDefinition
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/directory/roleEligibilitySchedules/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.directory.roleEligibilitySchedule_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/directory/roleEligibilitySchedules/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Retrieve the schedules for role eligibilities for which the signed-in user is the principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedule-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.directory.roleEligibilitySchedule_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleEligibilityScheduleFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleEligibilitySchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/entitlementManagement:
get:
tags:
- roleManagement.rbacApplication
summary: Get entitlementManagement from roleManagement
description: Container for roles and assignments for entitlement management resources.
operationId: roleManagement_GetEntitlementManagement
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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.rbacApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property entitlementManagement in roleManagement
operationId: roleManagement_UpdateEntitlementManagement
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.rbacApplication'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.rbacApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property entitlementManagement for roleManagement
operationId: roleManagement_DeleteEntitlementManagement
parameters:
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/resourceNamespaces:
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceNamespaces from roleManagement
operationId: roleManagement.entitlementManagement_ListResourceNamespace
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.unifiedRbacResourceNamespaceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to resourceNamespaces for roleManagement
operationId: roleManagement.entitlementManagement_CreateResourceNamespace
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/resourceNamespaces/{unifiedRbacResourceNamespace-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceNamespaces from roleManagement
operationId: roleManagement.entitlementManagement_GetResourceNamespace
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property resourceNamespaces in roleManagement
operationId: roleManagement.entitlementManagement_UpdateResourceNamespace
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property resourceNamespaces for roleManagement
operationId: roleManagement.entitlementManagement_DeleteResourceNamespace
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/resourceNamespaces/{unifiedRbacResourceNamespace-id}/resourceActions':
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceActions from roleManagement
operationId: roleManagement.entitlementManagement.resourceNamespace_ListResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- $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.unifiedRbacResourceActionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to resourceActions for roleManagement
operationId: roleManagement.entitlementManagement.resourceNamespace_CreateResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/resourceNamespaces/{unifiedRbacResourceNamespace-id}/resourceActions/{unifiedRbacResourceAction-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get resourceActions from roleManagement
operationId: roleManagement.entitlementManagement.resourceNamespace_GetResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: unifiedRbacResourceAction-id
in: path
description: The unique identifier of unifiedRbacResourceAction
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceAction
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property resourceActions in roleManagement
operationId: roleManagement.entitlementManagement.resourceNamespace_UpdateResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: unifiedRbacResourceAction-id
in: path
description: The unique identifier of unifiedRbacResourceAction
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceAction
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property resourceActions for roleManagement
operationId: roleManagement.entitlementManagement.resourceNamespace_DeleteResourceAction
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- name: unifiedRbacResourceAction-id
in: path
description: The unique identifier of unifiedRbacResourceAction
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceAction
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/resourceNamespaces/{unifiedRbacResourceNamespace-id}/resourceActions/$count':
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.resourceNamespace.resourceAction_GetCount
parameters:
- name: unifiedRbacResourceNamespace-id
in: path
description: The unique identifier of unifiedRbacResourceNamespace
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRbacResourceNamespace
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/entitlementManagement/resourceNamespaces/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.resourceNamespace_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/entitlementManagement/roleAssignments:
get:
tags:
- roleManagement.rbacApplication
summary: List unifiedRoleAssignments
description: "Get a list of unifiedRoleAssignment objects for the RBAC provider. The following RBAC providers are currently supported:\r\n- directory (Microsoft Entra ID)\r\n- entitlement management (Microsoft Entra entitlement management)"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roleassignments?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement_ListRoleAssignment
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.unifiedRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create unifiedRoleAssignment
description: Create a new unifiedRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-post-roleassignments?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement_CreateRoleAssignment
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignments/{unifiedRoleAssignment-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignments from roleManagement
description: Resource to grant access to users or groups.
operationId: roleManagement.entitlementManagement_GetRoleAssignment
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignments in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleAssignment
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignments for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleAssignment
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignments/{unifiedRoleAssignment-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app specific scope when the assignment scope is app specific. Containment entity. Supports $expand for the entitlement provider only.
operationId: roleManagement.entitlementManagement.roleAssignment_GetAppScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property appScope in roleManagement
operationId: roleManagement.entitlementManagement.roleAssignment_UpdateAppScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property appScope for roleManagement
operationId: roleManagement.entitlementManagement.roleAssignment_DeleteAppScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignments/{unifiedRoleAssignment-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment. Read-only. Supports $expand for the directory provider.
operationId: roleManagement.entitlementManagement.roleAssignment_GetDirectoryScope
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignments/{unifiedRoleAssignment-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: Referencing the assigned principal. Read-only. Supports $expand except for the Exchange provider.
operationId: roleManagement.entitlementManagement.roleAssignment_GetPrincipal
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignments/{unifiedRoleAssignment-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: The roleDefinition the assignment is for. Supports $expand.
operationId: roleManagement.entitlementManagement.roleAssignment_GetRoleDefinition
parameters:
- name: unifiedRoleAssignment-id
in: path
description: The unique identifier of unifiedRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignment
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleAssignments/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleAssignment_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/entitlementManagement/roleAssignmentScheduleInstances:
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignmentScheduleInstances from roleManagement
description: Instances for active role assignments.
operationId: roleManagement.entitlementManagement_ListRoleAssignmentScheduleInstance
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.unifiedRoleAssignmentScheduleInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleAssignmentScheduleInstances for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleAssignmentScheduleInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignmentScheduleInstances from roleManagement
description: Instances for active role assignments.
operationId: roleManagement.entitlementManagement_GetRoleAssignmentScheduleInstance
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignmentScheduleInstances in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleAssignmentScheduleInstance
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignmentScheduleInstances for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleAssignmentScheduleInstance
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/activatedUsing':
get:
tags:
- roleManagement.rbacApplication
summary: Get activatedUsing from roleManagement
description: 'If the request is from an eligible administrator to activate a role, this parameter shows the related eligible assignment for that activation. Otherwise, it''s null. Supports $expand and $select nested in $expand.'
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_GetActivatedUsing
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_GetAppScope
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment or role eligibility. Read-only.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_GetDirectoryScope
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or role eligibility through the request.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_GetPrincipal
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/{unifiedRoleAssignmentScheduleInstance-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_GetRoleDefinition
parameters:
- name: unifiedRoleAssignmentScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/entitlementManagement/roleAssignmentScheduleInstances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Get the instances of active role assignments for the calling principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentscheduleinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleInstance_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleAssignmentScheduleInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleAssignmentScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/entitlementManagement/roleAssignmentScheduleRequests:
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignmentScheduleRequests from roleManagement
description: Requests for active role assignments to principals through PIM.
operationId: roleManagement.entitlementManagement_ListRoleAssignmentScheduleRequest
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.unifiedRoleAssignmentScheduleRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleAssignmentScheduleRequests for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleAssignmentScheduleRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignmentScheduleRequests from roleManagement
description: Requests for active role assignments to principals through PIM.
operationId: roleManagement.entitlementManagement_GetRoleAssignmentScheduleRequest
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignmentScheduleRequests in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleAssignmentScheduleRequest
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignmentScheduleRequests for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleAssignmentScheduleRequest
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/activatedUsing':
get:
tags:
- roleManagement.rbacApplication
summary: Get activatedUsing from roleManagement
description: 'If the request is from an eligible administrator to activate a role, this parameter will show the related eligible assignment for that activation. Otherwise, it''s null. Supports $expand and $select nested in $expand.'
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetActivatedUsing
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the assignment is scoped to an app. Nullable. Supports $expand.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetAppScope
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment. Read-only. Supports $expand.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetDirectoryScope
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/microsoft.graph.cancel':
post:
tags:
- roleManagement.rbacApplication
summary: Invoke action cancel
description: 'Immediately cancel a unifiedRoleAssignmentScheduleRequest object that is in a Granted status, and have the system automatically delete the canceled request after 30 days. After calling this action, the status of the canceled unifiedRoleAssignmentScheduleRequest changes to Canceled.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedulerequest-cancel?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_cancel
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment through the request. Supports $expand and $select nested in $expand for id only.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetPrincipal
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the unifiedRoleDefinition object that is referenced through the roleDefinitionId property. Supports $expand and $select nested in $expand.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetRoleDefinition
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/{unifiedRoleAssignmentScheduleRequest-id}/targetSchedule':
get:
tags:
- roleManagement.rbacApplication
summary: Get targetSchedule from roleManagement
description: The schedule for an eligible role assignment that is referenced through the targetScheduleId property. Supports $expand and $select nested in $expand.
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetTargetSchedule
parameters:
- name: unifiedRoleAssignmentScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleAssignmentScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/entitlementManagement/roleAssignmentScheduleRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: 'In PIM, retrieve the requests for active role assignments for a particular principal. The principal can be the creator or approver of the unifiedRoleAssignmentScheduleRequest object, or they can be the target of the assignment.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedulerequest-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleAssignmentScheduleRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleAssignmentScheduleRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleAssignmentScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/entitlementManagement/roleAssignmentSchedules:
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignmentSchedules from roleManagement
description: Schedules for active role assignment operations.
operationId: roleManagement.entitlementManagement_ListRoleAssignmentSchedule
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.unifiedRoleAssignmentScheduleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleAssignmentSchedules for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleAssignmentSchedule
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleAssignmentSchedules from roleManagement
description: Schedules for active role assignment operations.
operationId: roleManagement.entitlementManagement_GetRoleAssignmentSchedule
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleAssignmentSchedules in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleAssignmentSchedule
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleAssignmentSchedules for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleAssignmentSchedule
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/activatedUsing':
get:
tags:
- roleManagement.rbacApplication
summary: Get activatedUsing from roleManagement
description: 'If the request is from an eligible administrator to activate a role, this parameter shows the related eligible assignment for that activation. Otherwise, it''s null. Supports $expand.'
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_GetActivatedUsing
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_GetAppScope
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the role eligibility or assignment. Read-only.
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_GetDirectoryScope
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or that's eligible for a role through the request.
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_GetPrincipal
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleAssignmentSchedules/{unifiedRoleAssignmentSchedule-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_GetRoleDefinition
parameters:
- name: unifiedRoleAssignmentSchedule-id
in: path
description: The unique identifier of unifiedRoleAssignmentSchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleAssignmentSchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleAssignmentSchedules/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/entitlementManagement/roleAssignmentSchedules/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Retrieve the schedules for active role assignment operations for which the signed-in user is the principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleassignmentschedule-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleAssignmentSchedule_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleAssignmentScheduleFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleAssignmentSchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/entitlementManagement/roleDefinitions:
get:
tags:
- roleManagement.rbacApplication
summary: List roleDefinitions
description: "Get a list of unifiedRoleDefinition objects for the provider. The following RBAC providers are currently supported:\r\n- directory (Microsoft Entra ID)\r\n- entitlement management (Microsoft Entra Entitlement Management)"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/rbacapplication-list-roledefinitions?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement_ListRoleDefinition
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.unifiedRoleDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleDefinitions for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleDefinitions/{unifiedRoleDefinition-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinitions from roleManagement
description: Resource representing the roles allowed by RBAC providers and the permissions assigned to the roles.
operationId: roleManagement.entitlementManagement_GetRoleDefinition
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleDefinitions in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleDefinition
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleDefinitions for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleDefinition
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleDefinitions/{unifiedRoleDefinition-id}/inheritsPermissionsFrom':
get:
tags:
- roleManagement.rbacApplication
summary: Get inheritsPermissionsFrom from roleManagement
description: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.
operationId: roleManagement.entitlementManagement.roleDefinition_ListInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- $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.unifiedRoleDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to inheritsPermissionsFrom for roleManagement
operationId: roleManagement.entitlementManagement.roleDefinition_CreateInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleDefinitions/{unifiedRoleDefinition-id}/inheritsPermissionsFrom/{unifiedRoleDefinition-id1}':
get:
tags:
- roleManagement.rbacApplication
summary: Get inheritsPermissionsFrom from roleManagement
description: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.
operationId: roleManagement.entitlementManagement.roleDefinition_GetInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: unifiedRoleDefinition-id1
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property inheritsPermissionsFrom in roleManagement
operationId: roleManagement.entitlementManagement.roleDefinition_UpdateInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: unifiedRoleDefinition-id1
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property inheritsPermissionsFrom for roleManagement
operationId: roleManagement.entitlementManagement.roleDefinition_DeleteInheritsPermissionsFrom
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: unifiedRoleDefinition-id1
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleDefinitions/{unifiedRoleDefinition-id}/inheritsPermissionsFrom/$count':
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleDefinition.inheritsPermissionsFrom_GetCount
parameters:
- name: unifiedRoleDefinition-id
in: path
description: The unique identifier of unifiedRoleDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleDefinition
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/entitlementManagement/roleDefinitions/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleDefinition_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/roleManagement/entitlementManagement/roleEligibilityScheduleInstances:
get:
tags:
- roleManagement.rbacApplication
summary: Get roleEligibilityScheduleInstances from roleManagement
description: Instances for role eligibility requests.
operationId: roleManagement.entitlementManagement_ListRoleEligibilityScheduleInstance
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.unifiedRoleEligibilityScheduleInstanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleEligibilityScheduleInstances for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleEligibilityScheduleInstance
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleEligibilityScheduleInstances from roleManagement
description: Instances for role eligibility requests.
operationId: roleManagement.entitlementManagement_GetRoleEligibilityScheduleInstance
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleEligibilityScheduleInstances in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleEligibilityScheduleInstance
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleEligibilityScheduleInstances for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleEligibilityScheduleInstance
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the assignment or role eligibility is scoped to an app. Nullable.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleInstance_GetAppScope
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the assignment or role eligibility. Read-only.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleInstance_GetDirectoryScope
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or role eligibility through the request.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleInstance_GetPrincipal
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/{unifiedRoleEligibilityScheduleInstance-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleInstance_GetRoleDefinition
parameters:
- name: unifiedRoleEligibilityScheduleInstance-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleInstance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleInstance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleInstance_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/entitlementManagement/roleEligibilityScheduleInstances/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Get the instances of eligible roles for the calling principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityscheduleinstance-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleInstance_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleEligibilityScheduleInstanceFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleEligibilityScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/entitlementManagement/roleEligibilityScheduleRequests:
get:
tags:
- roleManagement.rbacApplication
summary: Get roleEligibilityScheduleRequests from roleManagement
description: Requests for role eligibilities for principals through PIM.
operationId: roleManagement.entitlementManagement_ListRoleEligibilityScheduleRequest
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.unifiedRoleEligibilityScheduleRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleEligibilityScheduleRequests for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleEligibilityScheduleRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleEligibilityScheduleRequests from roleManagement
description: Requests for role eligibilities for principals through PIM.
operationId: roleManagement.entitlementManagement_GetRoleEligibilityScheduleRequest
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleEligibilityScheduleRequests in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleEligibilityScheduleRequest
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleEligibilityScheduleRequests for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleEligibilityScheduleRequest
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the role eligibility is scoped to an app. Nullable. Supports $expand.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_GetAppScope
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the role eligibility. Read-only. Supports $expand.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_GetDirectoryScope
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/microsoft.graph.cancel':
post:
tags:
- roleManagement.rbacApplication
summary: Invoke action cancel
description: 'Immediately cancel a unifiedRoleEligibilityScheduleRequest object whose status is Granted and have the system automatically delete the cancelled request after 30 days. After calling this action, the status of the cancelled unifiedRoleEligibilityScheduleRequest changes to Revoked.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedulerequest-cancel?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_cancel
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role eligibility through the request. Supports $expand.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_GetPrincipal
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the unifiedRoleDefinition object that is referenced through the roleDefinitionId property. Supports $expand.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_GetRoleDefinition
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/{unifiedRoleEligibilityScheduleRequest-id}/targetSchedule':
get:
tags:
- roleManagement.rbacApplication
summary: Get targetSchedule from roleManagement
description: The schedule for a role eligibility that is referenced through the targetScheduleId property. Supports $expand.
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_GetTargetSchedule
parameters:
- name: unifiedRoleEligibilityScheduleRequest-id
in: path
description: The unique identifier of unifiedRoleEligibilityScheduleRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilityScheduleRequest
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/entitlementManagement/roleEligibilityScheduleRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: 'In PIM, retrieve the requests for role eligibilities for a particular principal. The principal can be the creator or approver of the unifiedRoleEligibilityScheduleRequest object, or they can be the target of the role eligibility.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedulerequest-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleEligibilityScheduleRequest_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleEligibilityScheduleRequestFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleEligibilityScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/roleManagement/entitlementManagement/roleEligibilitySchedules:
get:
tags:
- roleManagement.rbacApplication
summary: Get roleEligibilitySchedules from roleManagement
description: Schedules for role eligibility operations.
operationId: roleManagement.entitlementManagement_ListRoleEligibilitySchedule
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.unifiedRoleEligibilityScheduleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- roleManagement.rbacApplication
summary: Create new navigation property to roleEligibilitySchedules for roleManagement
operationId: roleManagement.entitlementManagement_CreateRoleEligibilitySchedule
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleEligibilitySchedules from roleManagement
description: Schedules for role eligibility operations.
operationId: roleManagement.entitlementManagement_GetRoleEligibilitySchedule
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- roleManagement.rbacApplication
summary: Update the navigation property roleEligibilitySchedules in roleManagement
operationId: roleManagement.entitlementManagement_UpdateRoleEligibilitySchedule
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- roleManagement.rbacApplication
summary: Delete navigation property roleEligibilitySchedules for roleManagement
operationId: roleManagement.entitlementManagement_DeleteRoleEligibilitySchedule
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/appScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get appScope from roleManagement
description: Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.
operationId: roleManagement.entitlementManagement.roleEligibilitySchedule_GetAppScope
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appScope'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/directoryScope':
get:
tags:
- roleManagement.rbacApplication
summary: Get directoryScope from roleManagement
description: The directory object that is the scope of the role eligibility or assignment. Read-only.
operationId: roleManagement.entitlementManagement.roleEligibilitySchedule_GetDirectoryScope
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/principal':
get:
tags:
- roleManagement.rbacApplication
summary: Get principal from roleManagement
description: The principal that's getting a role assignment or that's eligible for a role through the request.
operationId: roleManagement.entitlementManagement.roleEligibilitySchedule_GetPrincipal
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/roleManagement/entitlementManagement/roleEligibilitySchedules/{unifiedRoleEligibilitySchedule-id}/roleDefinition':
get:
tags:
- roleManagement.rbacApplication
summary: Get roleDefinition from roleManagement
description: Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.
operationId: roleManagement.entitlementManagement.roleEligibilitySchedule_GetRoleDefinition
parameters:
- name: unifiedRoleEligibilitySchedule-id
in: path
description: The unique identifier of unifiedRoleEligibilitySchedule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleEligibilitySchedule
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/roleManagement/entitlementManagement/roleEligibilitySchedules/$count:
get:
tags:
- roleManagement.rbacApplication
summary: Get the number of the resource
operationId: roleManagement.entitlementManagement.roleEligibilitySchedule_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/roleManagement/entitlementManagement/roleEligibilitySchedules/microsoft.graph.filterByCurrentUser(on=''{on}'')':
get:
tags:
- roleManagement.rbacApplication
summary: Invoke function filterByCurrentUser
description: Retrieve the schedules for role eligibilities for which the signed-in user is the principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedroleeligibilityschedule-filterbycurrentuser?view=graph-rest-1.0
operationId: roleManagement.entitlementManagement.roleEligibilitySchedule_filterGraphBPreCurrentUser
parameters:
- name: on
in: path
description: 'Usage: on=''{on}'''
required: true
style: simple
schema:
$ref: '#/components/schemas/microsoft.graph.roleEligibilityScheduleFilterByCurrentUserOptions'
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of unifiedRoleEligibilitySchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/users/{user-id}/agreementAcceptances':
get:
tags:
- users.agreementAcceptance
summary: Get agreementAcceptances from users
description: The user's terms of use acceptance statuses. Read-only. Nullable.
operationId: user_ListAgreementAcceptance
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $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.agreementAcceptanceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/agreementAcceptances/{agreementAcceptance-id}':
get:
tags:
- users.agreementAcceptance
summary: Get agreementAcceptances from users
description: The user's terms of use acceptance statuses. Read-only. Nullable.
operationId: user_GetAgreementAcceptance
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: agreementAcceptance-id
in: path
description: The unique identifier of agreementAcceptance
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
- 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 navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/agreementAcceptances/$count':
get:
tags:
- users.agreementAcceptance
summary: Get the number of the resource
operationId: user.agreementAcceptance_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
components:
schemas:
microsoft.graph.agreement:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreement
type: object
properties:
displayName:
type: string
description: Display name of the agreement. The display name is used for internal tracking of the agreement but isn't shown to end users who view the agreement. Supports $filter (eq).
nullable: true
isPerDeviceAcceptanceRequired:
type: boolean
description: 'Indicates whether end users are required to accept this agreement on every device that they access it from. The end user is required to register their device in Microsoft Entra ID, if they haven''t already done so. Supports $filter (eq).'
nullable: true
isViewingBeforeAcceptanceRequired:
type: boolean
description: Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).
nullable: true
termsExpiration:
$ref: '#/components/schemas/microsoft.graph.termsExpiration'
userReacceptRequiredFrequency:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: The duration after which the user must reaccept the terms of use. The value is represented in ISO 8601 format for durations. Supports $filter (eq).
format: duration
nullable: true
acceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: Read-only. Information about acceptances of this agreement.
x-ms-navigationProperty: true
file:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
files:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementAcceptance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementAcceptance
type: object
properties:
agreementFileId:
type: string
description: The identifier of the agreement file accepted by the user.
nullable: true
agreementId:
type: string
description: The identifier of the agreement.
nullable: true
deviceDisplayName:
type: string
description: The display name of the device used for accepting the agreement.
nullable: true
deviceId:
type: string
description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
nullable: true
deviceOSType:
type: string
description: The operating system used to accept the agreement.
nullable: true
deviceOSVersion:
type: string
description: The operating system version of the device used to accept the agreement.
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ge, le) and eq for null values.'
format: date-time
nullable: true
recordedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState'
userDisplayName:
type: string
description: Display name of the user when the acceptance was recorded.
nullable: true
userEmail:
type: string
description: Email of the user when the acceptance was recorded.
nullable: true
userId:
type: string
description: The identifier of the user who accepted the agreement. Supports $filter (eq).
nullable: true
userPrincipalName:
type: string
description: UPN of the user when the acceptance was recorded.
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementFile:
allOf:
- $ref: '#/components/schemas/microsoft.graph.agreementFileProperties'
- title: agreementFile
type: object
properties:
localizations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
description: The localized version of the terms of use agreement files attached to the agreement.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementFileLocalization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.agreementFileProperties'
- title: agreementFileLocalization
type: object
properties:
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
description: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementFileVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.agreementFileProperties'
- title: agreementFileVersion
type: object
additionalProperties:
type: object
microsoft.graph.identityGovernance:
title: identityGovernance
type: object
properties:
accessReviews:
$ref: '#/components/schemas/microsoft.graph.accessReviewSet'
appConsent:
$ref: '#/components/schemas/microsoft.graph.appConsentApprovalRoute'
catalogs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
x-ms-navigationProperty: true
entitlementManagement:
$ref: '#/components/schemas/microsoft.graph.entitlementManagement'
lifecycleWorkflows:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowsContainer'
privilegedAccess:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessRoot'
termsOfUse:
$ref: '#/components/schemas/microsoft.graph.termsOfUseContainer'
additionalProperties:
type: object
microsoft.graph.accessReviewSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewSet
type: object
properties:
definitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
description: Represents the template and scheduling for an access review.
x-ms-navigationProperty: true
historyDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
description: Represents a collection of access review history data and the scopes used to collect that data.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewScheduleDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewScheduleDefinition
type: object
properties:
additionalNotificationRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientItem'
description: Defines the list of additional users or group members to be notified of the access review progress.
createdBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the access review series was created. Supports $select. Read-only.
format: date-time
nullable: true
descriptionForAdmins:
type: string
description: Description provided by review creators to provide more context of the review to admins. Supports $select.
nullable: true
descriptionForReviewers:
type: string
description: Description provided by review creators to provide more context of the review to reviewers. Reviewers see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.
nullable: true
displayName:
type: string
description: Name of the access review series. Supports $select and $orderby. Required on create.
nullable: true
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn''t exist, or manager is specified as reviewer but a user''s manager doesn''t exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.'
instanceEnumerationScope:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the access review series was last modified. Supports $select. Read-only.
format: date-time
nullable: true
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.'
scope:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
settings:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleSettings'
stageSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStageSettings'
description: 'Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages are created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.'
status:
type: string
description: 'This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
description: 'If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that doesn''t recur will have exactly one instance. Instances also represent each unique resource under review in the accessReviewScheduleDefinition. If a review has multiple resources and multiple instances, each resource has a unique instance for each recurrence.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewInstance
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'DateTime when review instance is scheduled to end.The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
format: date-time
nullable: true
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist. Supports $select.'
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
scope:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'DateTime when review instance is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
format: date-time
nullable: true
status:
type: string
description: 'Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
contactedReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
description: 'Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.'
x-ms-navigationProperty: true
decisions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
description: 'Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.'
x-ms-navigationProperty: true
stages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
description: 'If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewReviewer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewReviewer
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date when the reviewer was added for the access review.
format: date-time
nullable: true
displayName:
type: string
description: Name of reviewer.
nullable: true
userPrincipalName:
type: string
description: User principal name of the reviewer.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewInstanceDecisionItem
type: object
properties:
accessReviewId:
type: string
description: The identifier of the accessReviewInstance parent. Supports $select. Read-only.
appliedBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
appliedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The timestamp when the approval decision was applied.00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn''t applied the decision or it was automatically applied. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
format: date-time
nullable: true
applyResult:
type: string
description: 'The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
decision:
type: string
description: 'Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).'
nullable: true
justification:
type: string
description: Justification left by the reviewer when they made the decision.
nullable: true
principal:
$ref: '#/components/schemas/microsoft.graph.identity'
principalLink:
type: string
description: 'A link to the principal object. For example, https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.'
nullable: true
recommendation:
type: string
description: 'A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. The value is Approve if the sign-in is fewer than 30 days after the start of review, Deny if the sign-in is greater than 30 days after, or NoInfoAvailable. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
resource:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemResource'
resourceLink:
type: string
description: 'A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.'
nullable: true
reviewedBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
reviewedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The timestamp when the review decision occurred. Supports $select. Read-only.
format: date-time
nullable: true
insights:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.governanceInsight:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: governanceInsight
type: object
properties:
insightCreatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Indicates when the insight was created.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItemFilterByCurrentUserOptions:
title: accessReviewInstanceDecisionItemFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewStage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewStage
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time in ISO 8601 format and UTC time when the review stage is scheduled to end. This property is the cumulative total of the durationInDays for all stages. Read-only.
format: date-time
nullable: true
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn''t exist, or manager is specified as reviewer but a user''s manager doesn''t exist.'
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of access review scopes is used to define who the reviewers are. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time in ISO 8601 format and UTC time when the review stage is scheduled to start. Read-only.
format: date-time
nullable: true
status:
type: string
description: 'Specifies the status of an accessReviewStage. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $orderby, and $filter (eq only). Read-only.'
nullable: true
decisions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
description: 'Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewStageFilterByCurrentUserOptions:
title: accessReviewStageFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewInstanceFilterByCurrentUserOptions:
title: accessReviewInstanceFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewScheduleDefinitionFilterByCurrentUserOptions:
title: accessReviewScheduleDefinitionFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewHistoryDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewHistoryDefinition
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the access review definition was created.
format: date-time
decisions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDecisionFilter'
description: 'Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions are included by default if no decisions are provided on create. The possible values are: approve, deny, dontKnow, notReviewed, and notNotified.'
displayName:
type: string
description: Name for the access review history data collection. Required.
reviewHistoryPeriodEndDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
format: date-time
reviewHistoryPeriodStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
format: date-time
scheduleSettings:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryScheduleSettings'
scopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
description: Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
status:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryStatus'
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
description: 'If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn''t recur will have exactly one instance.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewHistoryInstance
type: object
properties:
downloadUri:
type: string
description: Uri that can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when this instance and associated data expires and the history is deleted. Required.
format: date-time
fulfilledDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when all of the available data for this instance was collected and is set after this instance's status is set to done. Required.
format: date-time
nullable: true
reviewHistoryPeriodEndDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp reviews ending on or before this date will be included in the fetched history data.
format: date-time
nullable: true
reviewHistoryPeriodStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp reviews starting on or after this date will be included in the fetched history data.
format: date-time
nullable: true
runDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the instance's history data is scheduled to be generated.
format: date-time
status:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryStatus'
additionalProperties:
type: object
microsoft.graph.appConsentApprovalRoute:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: appConsentApprovalRoute
type: object
properties:
appConsentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
description: A collection of appConsentRequest objects representing apps for which admin consent has been requested by one or more users.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.appConsentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: appConsentRequest
type: object
properties:
appDisplayName:
type: string
description: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.
nullable: true
appId:
type: string
description: The identifier of the application. Required. Supports $filter (eq only) and $orderby.
pendingScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequestScope'
description: A list of pending scopes waiting for approval. Required.
userConsentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
description: A list of pending user consent requests. Supports $filter (eq).
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userConsentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: userConsentRequest
type: object
properties:
reason:
type: string
description: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
nullable: true
approval:
$ref: '#/components/schemas/microsoft.graph.approval'
additionalProperties:
type: object
microsoft.graph.approval:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: approval
type: object
properties:
stages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
description: A collection of stages in the approval decision.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.approvalStage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: approvalStage
type: object
properties:
assignedToMe:
type: boolean
description: Indicates whether the stage is assigned to the calling user to review. Read-only.
nullable: true
displayName:
type: string
description: The label provided by the policy creator to identify an approval stage. Read-only.
nullable: true
justification:
type: string
description: The justification associated with the approval stage decision.
nullable: true
reviewedBy:
$ref: '#/components/schemas/microsoft.graph.identity'
reviewedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
reviewResult:
type: string
description: 'The result of this approval record. Possible values include: NotReviewed, Approved, Denied.'
nullable: true
status:
type: string
description: 'The stage status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.consentRequestFilterByCurrentUserOptions:
title: consentRequestFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessPackageCatalog:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageCatalog
type: object
properties:
catalogType:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalogType'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
description:
type: string
description: The description of the access package catalog.
nullable: true
displayName:
type: string
description: The display name of the access package catalog.
nullable: true
isExternallyVisible:
type: boolean
description: Whether the access packages in this catalog can be requested by users outside of the tenant.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalogState'
accessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: The access packages in this catalog. Read-only. Nullable.
x-ms-navigationProperty: true
customWorkflowExtensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
x-ms-navigationProperty: true
resourceRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
description: Access package resources in this catalog.
x-ms-navigationProperty: true
resourceScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackage
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
description:
type: string
description: The description of the access package.
nullable: true
displayName:
type: string
description: 'Required. The display name of the access package. Supports $filter (eq, contains).'
nullable: true
isHidden:
type: boolean
description: Indicates whether the access package is hidden from the requestor.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
accessPackagesIncompatibleWith:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: The access packages that are incompatible with this package. Read-only.
x-ms-navigationProperty: true
assignmentPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
description: Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
catalog:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
incompatibleAccessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: The access packages whose assigned users are ineligible to be assigned this access package.
x-ms-navigationProperty: true
incompatibleGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
description: The groups whose members are ineligible to be assigned this access package.
x-ms-navigationProperty: true
resourceRoleScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
description: The resource roles and scopes in this access package.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.customCalloutExtension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: customCalloutExtension
type: object
properties:
authenticationConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionAuthenticationConfiguration'
clientConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionClientConfiguration'
description:
type: string
description: Description for the customCalloutExtension object.
nullable: true
displayName:
type: string
description: Display name for the customCalloutExtension object.
nullable: true
endpointConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionEndpointConfiguration'
additionalProperties:
type: object
microsoft.graph.accessPackageResourceRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageResourceRole
type: object
properties:
description:
type: string
description: A description for the resource role.
nullable: true
displayName:
type: string
description: The display name of the resource role such as the role defined by the application.
nullable: true
originId:
type: string
description: 'The unique identifier of the resource role in the origin system. For a SharePoint Online site, the originId is the sequence number of the role in the site.'
nullable: true
originSystem:
type: string
description: 'The type of the resource in the origin system, such as SharePointOnline, AadApplication, AzureResources, or AadGroup.'
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.roleType'
resource:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
additionalProperties:
type: object
microsoft.graph.accessPackageResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageResource
type: object
properties:
attributes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceAttribute'
description: Contains information about the attributes to be collected from the requestor and sent to the resource application.
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
description:
type: string
description: A description for the resource.
nullable: true
displayName:
type: string
description: 'The display name of the resource, such as the application name, group name or site name.'
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
originId:
type: string
description: 'The unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group.'
nullable: true
originSystem:
type: string
description: 'The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup.'
nullable: true
environment:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
roles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
description: Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
scopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
description: Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
uploadSessions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
description: The upload sessions for uploading external access data to this resource through the Bring Your Own Data (BYOD) flow.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceEnvironment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageResourceEnvironment
type: object
properties:
connectionInfo:
$ref: '#/components/schemas/microsoft.graph.connectionInfo'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time that this object was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
description:
type: string
description: The description of this object.
nullable: true
displayName:
type: string
description: The display name of this object.
nullable: true
isDefaultEnvironment:
type: boolean
description: 'Determines whether this is default environment or not. It is set to true for all static origin systems, such as Microsoft Entra groups and Microsoft Entra Applications.'
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time that this object was last modified. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
originId:
type: string
description: The unique identifier of this environment in the origin system.
nullable: true
originSystem:
type: string
description: 'The type of the resource in the origin system, that is, SharePointOnline. Requires $filter (eq).'
nullable: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
description: Read-only. Required.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceScope:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageResourceScope
type: object
properties:
description:
type: string
description: The description of the scope.
nullable: true
displayName:
type: string
description: The display name of the scope.
nullable: true
isRootScope:
type: boolean
description: True if the scopes are arranged in a hierarchy and this is the top or root scope of the resource.
nullable: true
originId:
type: string
description: 'The unique identifier of the resource in the origin system. If a Microsoft Entra group, originId is the identifier of the group. Supports $filter (eq).'
nullable: true
originSystem:
type: string
description: 'The type of the resource in the origin system, such as SharePointOnline, AadApplication, AadGroup, AzureResources, or CustomDataProvidedResource. Supports $filter (eq).'
nullable: true
resource:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourceUploadSession:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: customDataProvidedResourceUploadSession
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: DateTime when the upload session was created. Read-only. Supports $orderby.
format: date-time
data:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourcePayloads.data'
isUploadDone:
type: boolean
description: Indicates if all the necessary files have been uploaded to this session.
referenceId:
type: string
description: 'The ID of the context for which data is being uploaded, for example, the Access Review instance ID. Supports $filter (eq).'
nullable: true
stats:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadStats'
status:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadStatus'
files:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
description: The files uploaded during this upload session. Supports $expand and $expand with nested $filter and $orderby.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourceFile:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: customDataProvidedResourceFile
type: object
properties:
name:
type: string
description: 'Name of the uploaded file, including the file extension. Required. Supports $filter (eq, ne) and $orderby.'
size:
type: number
description: 'Size of the file in bytes. Read-only. Supports $filter (eq, ne, gt, ge, lt, le) and $orderby.'
format: int64
uploadedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp when the file was uploaded. Read-only. Supports $filter (eq, ne, gt, ge, lt, le) and $orderby.'
format: date-time
additionalProperties:
type: object
microsoft.graph.entitlementManagement:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: entitlementManagement
type: object
properties:
accessPackageAssignmentApprovals:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
description: Approval stages for decisions associated with access package assignment requests.
x-ms-navigationProperty: true
accessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: Access packages define the collection of resource roles and the policies for which subjects can request or be assigned access to those resources.
x-ms-navigationProperty: true
accessPackageSuggestions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
description: Suggested access packages for end users based on various criteria such as related people insights and assignment history.
x-ms-navigationProperty: true
assignmentPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
description: Access package assignment policies govern which subjects can request or be assigned an access package via an access package assignment.
x-ms-navigationProperty: true
assignmentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
description: Access package assignment requests created by or on behalf of a subject.
x-ms-navigationProperty: true
assignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
description: The assignment of an access package to a subject for a period of time.
x-ms-navigationProperty: true
availableAccessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
description: Access packages available for end users to browse and request.
x-ms-navigationProperty: true
catalogs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
description: A container for access packages.
x-ms-navigationProperty: true
connectedOrganizations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
description: References to a directory or domain of another organization whose users can request access.
x-ms-navigationProperty: true
controlConfigurations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
description: Configuration settings that control the lifecycle and access policies of entitlement management within a tenant.
x-ms-navigationProperty: true
resourceEnvironments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
description: A reference to the geolocation environments in which a resource is located.
x-ms-navigationProperty: true
resourceRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
description: Represents a request to add or remove a resource to or from a catalog respectively.
x-ms-navigationProperty: true
resourceRoleScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
description: The resources associated with the catalogs.
x-ms-navigationProperty: true
settings:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings'
subjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.approvalFilterByCurrentUserOptions:
title: approvalFilterByCurrentUserOptions
enum:
- target
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.accessPackageAssignmentPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageAssignmentPolicy
type: object
properties:
allowedTargetScope:
$ref: '#/components/schemas/microsoft.graph.allowedTargetScope'
automaticRequestSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAutomaticRequestSettings'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
description:
type: string
description: The description of the policy.
nullable: true
displayName:
type: string
description: The display name of the policy.
nullable: true
expiration:
$ref: '#/components/schemas/microsoft.graph.expirationPattern'
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
notificationSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageNotificationSettings'
requestApprovalSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentApprovalSettings'
requestorSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestorSettings'
reviewSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentReviewSettings'
specificAllowedTargets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: The principals that can be assigned access from an access package through this policy.
accessPackage:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
catalog:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
customExtensionStageSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
description: The collection of stages when to execute one or more custom access package workflow extensions. Supports $expand.
x-ms-navigationProperty: true
questions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
description: Questions that are posed to the requestor.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.customExtensionStageSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: customExtensionStageSetting
type: object
properties:
stage:
$ref: '#/components/schemas/microsoft.graph.accessPackageCustomExtensionStage'
customExtension:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
additionalProperties:
type: object
microsoft.graph.accessPackageQuestion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageQuestion
type: object
properties:
isAnswerEditable:
type: boolean
description: Specifies whether the requestor is allowed to edit answers to questions for an assignment by posting an update to accessPackageAssignmentRequest.
nullable: true
isRequired:
type: boolean
description: Whether the requestor is required to supply an answer or not.
nullable: true
localizations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageLocalizedText'
description: The text of the question represented in a format for a specific locale.
sequence:
maximum: 2147483647
minimum: -2147483648
type: number
description: Relative position of this question when displaying a list of questions to the requestor.
format: int32
nullable: true
text:
type: string
description: The text of the question to show to the requestor.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestRequirements:
title: accessPackageAssignmentRequestRequirements
type: object
properties:
allowCustomAssignmentSchedule:
type: boolean
description: Indicates whether the requestor is allowed to set a custom schedule.
nullable: true
isApprovalRequiredForAdd:
type: boolean
description: Indicates whether a request to add must be approved by an approver.
nullable: true
isApprovalRequiredForUpdate:
type: boolean
description: Indicates whether a request to update must be approved by an approver.
nullable: true
isRequestorJustificationRequired:
type: boolean
description: Indicates whether requestors must justify requesting access to an access package.
nullable: true
policyDescription:
type: string
description: The description of the policy that the user is trying to request access using.
nullable: true
policyDisplayName:
type: string
description: The display name of the policy that the user is trying to request access using.
nullable: true
policyId:
type: string
description: The identifier of the policy that these requirements are associated with. This identifier can be used when creating a new assignment request.
nullable: true
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
questions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceRoleScope:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageResourceRoleScope
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
role:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
scope:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
additionalProperties:
type: object
microsoft.graph.accessPackageFilterByCurrentUserOptions:
title: accessPackageFilterByCurrentUserOptions
enum:
- allowedRequestor
- unknownFutureValue
type: string
microsoft.graph.accessPackageSuggestion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageSuggestion
type: object
properties:
reasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestionReason'
description: A collection of reasons why this access package is being suggested to the user.
accessPackage:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
additionalProperties:
type: object
microsoft.graph.availableAccessPackage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: availableAccessPackage
type: object
properties:
description:
type: string
description: The description of the access package.
nullable: true
displayName:
type: string
description: The display name of the access package.
nullable: true
resourceRoleScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
description: The resource role scopes associated with this available access package.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageSuggestionFilterByCurrentUserOptions:
title: accessPackageSuggestionFilterByCurrentUserOptions
enum:
- none
- relatedPeopleAssignments
- assignmentHistory
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.accessPackageAssignmentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageAssignmentRequest
type: object
properties:
answers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAnswer'
description: Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date of the end of processing, either successful or failure, of a request. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter.'
format: date-time
nullable: true
customExtensionCalloutInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customExtensionCalloutInstance'
description: Information about all the custom extension calls that were made during the access package assignment workflow.
justification:
type: string
description: The requestor's supplied justification.
nullable: true
requestType:
$ref: '#/components/schemas/microsoft.graph.accessPackageRequestType'
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageRequestState'
status:
type: string
description: More information on the request processing status. Read-only.
nullable: true
accessPackage:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
assignment:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
requestor:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageAssignment
type: object
properties:
customExtensionCalloutInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customExtensionCalloutInstance'
description: Information about all the custom extension calls that were made during the access package assignment workflow.
expiredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentState'
status:
type: string
description: 'More information about the assignment lifecycle. Possible values include Delivering, Delivered, AutoAssignmentInGracePeriod, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.'
nullable: true
accessPackage:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
assignmentPolicy:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
target:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
additionalProperties:
type: object
microsoft.graph.customExtensionData:
title: customExtensionData
type: object
additionalProperties:
type: object
microsoft.graph.accessPackageSubject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageSubject
type: object
properties:
displayName:
type: string
description: The display name of the subject.
nullable: true
email:
type: string
description: The email address of the subject.
nullable: true
objectId:
type: string
description: The object identifier of the subject. null if the subject isn't yet a user in the tenant.
nullable: true
onPremisesSecurityIdentifier:
type: string
description: 'A string representation of the principal''s security identifier, if known, or null if the subject doesn''t have a security identifier.'
nullable: true
principalName:
type: string
description: 'The principal name, if known, of the subject.'
nullable: true
subjectLifecycle:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubjectLifecycle'
subjectType:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubjectType'
connectedOrganization:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestFilterByCurrentUserOptions:
title: accessPackageAssignmentRequestFilterByCurrentUserOptions
enum:
- target
- createdBy
- approver
- unknownFutureValue
- targetOrRequestor
- targetManager
- requestForOthers
- targetAgentIdentitySponsorOrOwner
type: string
microsoft.graph.accessPackageAssignmentFilterByCurrentUserOptions:
title: accessPackageAssignmentFilterByCurrentUserOptions
enum:
- target
- createdBy
- unknownFutureValue
- targetManager
- targetAgentIdentitySponsorOrOwner
type: string
microsoft.graph.connectedOrganization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: connectedOrganization
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
description:
type: string
description: The description of the connected organization.
nullable: true
displayName:
type: string
description: The display name of the connected organization. Supports $filter (eq).
nullable: true
identitySources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identitySource'
description: 'The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable.'
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.connectedOrganizationState'
externalSponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
internalSponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.controlConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: controlConfiguration
type: object
properties:
createdBy:
type: string
description: The userPrincipalName of the user or identity that created the control configuration.
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time the control configuration was created.
format: date-time
nullable: true
isEnabled:
type: boolean
description: Determines whether or not the control configuration is enabled.
modifiedBy:
type: string
description: The userPrincipalName of the user or identity that modified the control configuration.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time the control configuration was modified.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageResourceRequest
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
requestType:
$ref: '#/components/schemas/microsoft.graph.accessPackageRequestType'
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageRequestState'
catalog:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
resource:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
additionalProperties:
type: object
microsoft.graph.entitlementManagementSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: entitlementManagementSettings
type: object
properties:
durationUntilExternalUserDeletedAfterBlocked:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'If externalUserLifecycleAction is blockSignInAndDelete, the duration, typically many days, after an external user is blocked from sign in before their account is deleted.'
format: duration
nullable: true
externalUserLifecycleAction:
$ref: '#/components/schemas/microsoft.graph.accessPackageExternalUserLifecycleAction'
additionalProperties:
type: object
microsoft.graph.identityGovernance.lifecycleWorkflowsContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: lifecycleWorkflowsContainer
type: object
properties:
customTaskExtensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
description: The customTaskExtension instance.
x-ms-navigationProperty: true
deletedItems:
$ref: '#/components/schemas/microsoft.graph.deletedItemContainer'
insights:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.insights'
settings:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleManagementSettings'
taskDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskDefinition'
description: The definition of tasks within the lifecycle workflows instance.
x-ms-navigationProperty: true
workflows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
description: The workflows in the lifecycle workflows instance.
x-ms-navigationProperty: true
workflowTemplates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowTemplate'
description: The workflow templates in the lifecycle workflow instance.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.customTaskExtension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
- title: customTaskExtension
type: object
properties:
callbackConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionCallbackConfiguration'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'When the custom task extension was created.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'When the custom extension was last modified.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.user'
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
microsoft.graph.user:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: user
type: object
properties:
aboutMe:
type: string
description: A freeform text entry field for the user to describe themselves. Requires $select to retrieve.
nullable: true
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. This property is required when a user is created. Requires $select to retrieve. Supports $filter (eq, ne, not, and in). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
ageGroup:
type: string
description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions. Requires $select to retrieve. Supports $filter (eq, ne, not, and in).'
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn''t differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, /$count eq 0, /$count ne 0).'
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
description: The plans that are assigned to the user. Read-only. Not nullable. Requires $select to retrieve. Supports $filter (eq and not).
authorizationInfo:
$ref: '#/components/schemas/microsoft.graph.authorizationInfo'
birthday:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Requires $select to retrieve.'
format: date-time
businessPhones:
type: array
items:
type: string
description: 'The telephone numbers for the user. NOTE: Although it''s a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
city:
type: string
description: 'The city where the user is located. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
companyName:
type: string
description: 'The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters.Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
consentProvidedForMinor:
type: string
description: 'Sets whether consent was obtained for minors. Allowed values: null, Granted, Denied, and NotRequired. For more information, see legal age group property definitions. Requires $select to retrieve. Supports $filter (eq, ne, not, and in).'
nullable: true
country:
type: string
description: 'The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time the user was created, in ISO 8601 format and UTC. The value can''t be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
creationType:
type: string
description: 'Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by a guest signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Requires $select to retrieve. Supports $filter (eq, ne, not, in).'
nullable: true
customSecurityAttributes:
$ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue'
department:
type: string
description: 'The name of the department in which the user works. Maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).'
nullable: true
deviceEnrollmentLimit:
maximum: 2147483647
minimum: -2147483648
type: number
description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
format: int32
displayName:
type: string
description: 'The name displayed in the address book for the user. This value is usually the combination of the user''s first name, middle initial, and family name. This property is required when a user is created and it can''t be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search.'
nullable: true
employeeHireDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the user was hired or will start work in a future hire. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
employeeId:
type: string
description: 'The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
employeeLeaveDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator (least privilege), Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.'
format: date-time
nullable: true
employeeOrgData:
$ref: '#/components/schemas/microsoft.graph.employeeOrgData'
employeeType:
type: string
description: 'Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith).'
nullable: true
externalUserState:
type: string
description: 'For a guest invited to the tenant using the invitation API, this property represents the invited user''s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Requires $select to retrieve. Supports $filter (eq, ne, not , in).'
nullable: true
externalUserStateChangeDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Shows the timestamp for the latest change to the externalUserState property. Requires $select to retrieve. Supports $filter (eq, ne, not , in).'
format: date-time
nullable: true
faxNumber:
type: string
description: 'The fax number of the user. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
givenName:
type: string
description: 'The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
hireDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Requires $select to retrieve. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.'
format: date-time
identities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectIdentity'
description: 'Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Requires $select to retrieve. Supports $filter (eq) with limitations.'
identityParentId:
type: string
nullable: true
imAddresses:
type: array
items:
type: string
nullable: true
description: 'The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Requires $select to retrieve. Supports $filter (eq, not, ge, le, startsWith).'
interests:
type: array
items:
type: string
nullable: true
description: A list for the user to describe their interests. Requires $select to retrieve.
isManagementRestricted:
type: boolean
description: 'true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve.'
nullable: true
isResourceAccount:
type: boolean
description: Don't use – reserved for future use.
nullable: true
jobTitle:
type: string
description: 'The user''s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
lastPasswordChangeDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Requires $select to retrieve.'
format: date-time
nullable: true
legalAgeGroupClassification:
type: string
description: 'Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, Undefined, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Requires $select to retrieve.'
nullable: true
licenseAssignmentStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseAssignmentState'
description: State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Requires $select to retrieve.
mail:
type: string
description: 'The SMTP address for the user, for example, jeff@contoso.com. Changes to this property update the user''s proxyAddresses collection to include the value as an SMTP address. This property can''t contain accent characters. NOTE: We don''t recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
nullable: true
mailboxSettings:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
mailNickname:
type: string
description: 'The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mobilePhone:
type: string
description: 'The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search. This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
mySite:
type: string
description: The URL for the user's site. Requires $select to retrieve.
nullable: true
officeLocation:
type: string
description: 'The office location in the user''s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
onPremisesDistinguishedName:
type: string
description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve.
nullable: true
onPremisesDomainName:
type: string
description: 'Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesImmutableId:
type: string
description: 'This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you''re using a federated domain for the user''s userPrincipalName (UPN) property. NOTE: The $ and _ characters can''t be used when specifying this property. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
onPremisesLastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Requires $select to retrieve. Supports $filter (eq, not, ge, le).'
onPremisesSamAccountName:
type: string
description: 'Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Requires $select to retrieve. Supports $filter (eq including on null values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn''t being synced and can be managed in Microsoft Entra ID. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
onPremisesUserPrincipalName:
type: string
description: 'Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
otherMails:
type: array
items:
type: string
description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can''t contain accent characters. Requires $select to retrieve. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
passwordPolicies:
type: string
description: 'Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Requires $select to retrieve. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values).'
nullable: true
passwordProfile:
$ref: '#/components/schemas/microsoft.graph.passwordProfile'
pastProjects:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their past projects. Requires $select to retrieve.
postalCode:
type: string
description: 'The postal code for the user''s postal address. The postal code is specific to the user''s country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: ''en-US'', or ''es-ES''. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)'
nullable: true
preferredName:
type: string
description: The preferred name for the user. Not Supported. This attribute returns an empty string.Requires $select to retrieve.
nullable: true
print:
$ref: '#/components/schemas/microsoft.graph.userPrint'
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
description: 'The plans that are provisioned for the user. Read-only. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, ge, le).'
proxyAddresses:
type: array
items:
type: string
description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
responsibilities:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their responsibilities. Requires $select to retrieve.
schools:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate the schools they attended. Requires $select to retrieve.
securityIdentifier:
type: string
description: 'Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).'
nullable: true
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
showInAddressList:
type: boolean
description: Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
nullable: true
signInActivity:
$ref: '#/components/schemas/microsoft.graph.signInActivity'
signInSessionsValidFromDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Requires $select to retrieve.'
format: date-time
nullable: true
skills:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their skills. Requires $select to retrieve.
state:
type: string
description: 'The state or province in the user''s address. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
streetAddress:
type: string
description: 'The street address of the user''s place of business. Maximum length is 1,024 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
surname:
type: string
description: 'The user''s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
usageLocation:
type: string
description: 'A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: US, JP, and GB. Not nullable. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user''s email name. The general format is alias@domain, where the domain must be present in the tenant''s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property can''t contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, '' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby. This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
userType:
type: string
description: 'A string value that can be used to classify user types in your directory. The possible values are Member and Guest. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for members and guests, see What are the default user permissions in Microsoft Entra ID?'
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userActivity'
description: The user's activities across devices. Read-only. Nullable.
x-ms-navigationProperty: true
adhocCalls:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.adhocCall'
description: Ad hoc calls associated with the user. Read-only. Nullable.
x-ms-navigationProperty: true
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: The user's terms of use acceptance statuses. Read-only. Nullable.
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a user is granted for an application. Supports $expand.
x-ms-navigationProperty: true
authentication:
$ref: '#/components/schemas/microsoft.graph.authentication'
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
description: The user's calendar groups. Read-only. Nullable.
x-ms-navigationProperty: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The user's calendars. Read-only. Nullable.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
chats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chat'
x-ms-navigationProperty: true
cloudClipboard:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
cloudPCs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
description: The user's Cloud PCs. Read-only. Nullable.
x-ms-navigationProperty: true
contactFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The user's contacts folders. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The user's contacts. Read-only. Nullable.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects that the user created. Read-only. Nullable.
x-ms-navigationProperty: true
dataSecurityAndGovernance:
$ref: '#/components/schemas/microsoft.graph.userDataSecurityAndGovernance'
deviceManagementTroubleshootingEvents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent'
description: The list of troubleshooting events for this user.
x-ms-navigationProperty: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: A collection of drives available for this user. Read-only.
x-ms-navigationProperty: true
employeeExperience:
$ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.
x-ms-navigationProperty: true
followedSites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
x-ms-navigationProperty: true
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
insights:
$ref: '#/components/schemas/microsoft.graph.itemInsights'
joinedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.team'
x-ms-navigationProperty: true
licenseDetails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
description: A collection of this user's license details. Read-only.
x-ms-navigationProperty: true
mailFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The user's mail folders. Read-only. Nullable.
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
description: Zero or more managed app registrations that belong to the user.
x-ms-navigationProperty: true
managedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
description: The managed devices associated with the user.
x-ms-navigationProperty: true
manager:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The messages in a mailbox or folder. Read-only. Nullable.
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
onlineMeetings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
description: 'Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.'
x-ms-navigationProperty: true
onPremisesSyncBehavior:
$ref: '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
outlook:
$ref: '#/components/schemas/microsoft.graph.outlookUser'
ownedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Devices the user owns. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects the user owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
people:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.person'
description: People that are relevant to the user. Read-only. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: List all resource-specific permission grants of a user.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The collection of the user's profile photos in different sizes. Read-only.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
presence:
$ref: '#/components/schemas/microsoft.graph.presence'
registeredDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.
x-ms-navigationProperty: true
scopedRoleMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
x-ms-navigationProperty: true
settings:
$ref: '#/components/schemas/microsoft.graph.userSettings'
solutions:
$ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
sponsorOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects that this user sponsors, such as guest users, agent users, agent blueprints, agent blueprint principals, and agent identities. If the user is a member of a group that''s a sponsor, the objects sponsored by that group are also included. Read-only. Nullable. Supports $filter, $count, $select, $expand, $top, and $skip.'
x-ms-navigationProperty: true
sponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The users and groups responsible for this guest''s privileges in the tenant and keeping the guest''s information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.'
x-ms-navigationProperty: true
teamwork:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
todo:
$ref: '#/components/schemas/microsoft.graph.todo'
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups, including nested groups, and directory roles that a user is a member of. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.mailboxSettings:
title: mailboxSettings
type: object
properties:
archiveFolder:
type: string
description: Folder ID of an archive folder for the user.
nullable: true
automaticRepliesSetting:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
dateFormat:
type: string
description: The date format for the user's mailbox.
nullable: true
delegateMeetingMessageDeliveryOptions:
$ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions'
language:
$ref: '#/components/schemas/microsoft.graph.localeInfo'
timeFormat:
type: string
description: The time format for the user's mailbox.
nullable: true
timeZone:
type: string
description: The default time zone for the user's mailbox.
nullable: true
userPurpose:
$ref: '#/components/schemas/microsoft.graph.userPurpose'
workingHours:
$ref: '#/components/schemas/microsoft.graph.workingHours'
additionalProperties:
type: object
microsoft.graph.deletedItemContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deletedItemContainer
type: object
properties:
workflows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
description: Deleted workflows that end up in the deletedItemsContainer.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowBase'
- title: workflow
type: object
properties:
deletedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'When the workflow was deleted.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
id:
type: string
description: 'Identifier used for individually addressing a specific workflow.Supports $filter(eq, ne) and $orderby.'
nextScheduleRunDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time when the workflow is expected to run next based on the schedule interval, if there are any users matching the execution conditions. Supports $filter(lt,gt) and $orderby.'
format: date-time
nullable: true
quarantineDetails:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineDetails'
settings:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowSetting'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The current version number of the workflow. Value is 1 when the workflow is first created.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: int32
nullable: true
executionScope:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
description: The list of users that meet the workflowExecutionConditions of a workflow.
x-ms-navigationProperty: true
previewScope:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The preview scope for the workflow.
x-ms-navigationProperty: true
runs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
description: Workflow runs.
x-ms-navigationProperty: true
taskReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskReport'
description: Represents the aggregation of task execution data for tasks within a workflow object.
x-ms-navigationProperty: true
userProcessingResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
description: Per-user workflow execution results.
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowVersion'
description: The workflow versions that are available.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.directoryObject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryObject
type: object
properties:
deletedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time when this object was deleted. Always null when the object hasn't been deleted.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.userProcessingResult:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userProcessingResult
type: object
properties:
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the workflow execution for a user completed. Value is null if the workflow hasn''t completed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
failedTasksCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of tasks that failed in the workflow execution.
format: int32
processingStatus:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus'
scheduledDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the workflow is scheduled to be executed for a user.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
startedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the workflow execution started. Value is null if the workflow execution hasn''t started.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
totalTasksCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of tasks that in the workflow execution.
format: int32
totalUnprocessedTasksCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of unprocessed tasks for the workflow.
format: int32
workflowExecutionType:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowExecutionType'
workflowVersion:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the workflow that was executed.
format: int32
reprocessedRuns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
description: The related reprocessed workflow run.
x-ms-navigationProperty: true
subject:
$ref: '#/components/schemas/microsoft.graph.user'
taskProcessingResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
description: The associated individual task execution.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.activationScope:
title: activationScope
type: object
additionalProperties:
type: object
microsoft.graph.identityGovernance.cancelScope:
title: cancelScope
type: object
additionalProperties:
type: object
microsoft.graph.identityGovernance.previewFailedTask:
title: previewFailedTask
type: object
properties:
definitionId:
type: string
description: The identifier of the task definition of the task that failed during the preview operation of a workflow.
failureReason:
type: string
description: The reason why the task failed in the preview operation of a workflow.
name:
type: string
description: The name of the task that failed within the preview operation of a workflow.
taskId:
type: string
description: The identifier of the task that failed during the preview operation of a workflow.
additionalProperties:
type: object
microsoft.graph.identityGovernance.run:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: run
type: object
properties:
activatedOnScope:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.activationScope'
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the run completed. Value is null if the workflow hasn''t completed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
failedTasksCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of tasks that failed in the run execution.
format: int32
failedUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of users that failed in the run execution.
format: int32
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The datetime that the run was last updated.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
processingStatus:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus'
scheduledDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the run is scheduled to be executed for a workflow.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
startedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the run execution started.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
successfulUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of successfully completed users in the run.
format: int32
totalTasksCount:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
totalUnprocessedTasksCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of unprocessed tasks in the run execution.
format: int32
totalUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of users in the workflow execution.
format: int32
workflowExecutionType:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowExecutionType'
reprocessedRuns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
description: The related reprocessed workflow run.
x-ms-navigationProperty: true
taskProcessingResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
description: The related taskProcessingResults.
x-ms-navigationProperty: true
userProcessingResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
description: The associated individual user execution.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskProcessingResult:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: taskProcessingResult
type: object
properties:
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time when taskProcessingResult execution ended. Value is null if task execution is still in progress.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time when the taskProcessingResult was created.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
failureReason:
type: string
description: Describes why the taskProcessingResult failed.
nullable: true
processingInfo:
type: string
description: 'Additional human-readable context about the task processing outcome. This property contains information about edge cases where the task completed successfully but the expected action wasn''t performed because the target was already in the desired state, such as when the user was already a member of the specified group. Returns null when no additional context is needed. Nullable.'
nullable: true
processingStatus:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus'
startedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time when taskProcessingResult execution started. Value is null if task execution hasn''t started yet.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
subject:
$ref: '#/components/schemas/microsoft.graph.user'
task:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
additionalProperties:
type: object
microsoft.graph.identityGovernance.customTaskExtensionCallbackData:
allOf:
- $ref: '#/components/schemas/microsoft.graph.customExtensionData'
- title: customTaskExtensionCallbackData
type: object
properties:
operationStatus:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtensionOperationStatus'
additionalProperties:
type: object
microsoft.graph.identityGovernance.task:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: task
type: object
properties:
arguments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValuePair'
description: 'Arguments included within the task. For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.'
category:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleTaskCategory'
continueOnError:
type: boolean
description: 'A Boolean value that specifies whether, if this task fails, the workflow stops, and subsequent tasks aren''t run. Optional.'
description:
type: string
description: A string that describes the purpose of the task for administrative use. Optional.
nullable: true
displayName:
type: string
description: 'A unique string that identifies the task. Required.Supports $filter(eq, ne) and orderBy.'
executionSequence:
maximum: 2147483647
minimum: -2147483648
type: number
description: An integer that states in what order the task runs in a workflow.Supports $orderby.
format: int32
isEnabled:
type: boolean
description: 'A Boolean value that denotes whether the task is set to run or not. Optional.Supports $filter(eq, ne) and orderBy.'
taskDefinitionId:
type: string
description: 'A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.Supports $filter(eq, ne).'
taskProcessingResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
description: The result of processing the task.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.userSummary:
title: userSummary
type: object
properties:
failedTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of failed tasks for users in a user summary.
format: int32
failedUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of failed users in a user summary.
format: int32
successfulUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of successful users in a user summary.
format: int32
totalTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total tasks of users in a user summary.
format: int32
totalUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of users in a user summary
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.runSummary:
title: runSummary
type: object
properties:
failedRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of failed workflow runs.
format: int32
failedTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of failed tasks of a workflow.
format: int32
successfulRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of successful workflow runs.
format: int32
totalRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of runs for a workflow.
format: int32
totalTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of tasks processed by a workflow.
format: int32
totalUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of users processed by a workflow.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskReport:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: taskReport
type: object
properties:
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time that the associated run completed. Value is null if the run has not completed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: date-time
nullable: true
failedUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The number of users in the run execution for which the associated task failed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: int32
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time that the task report was last updated.
format: date-time
processingStatus:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus'
runId:
type: string
description: The unique identifier of the associated run.
nullable: true
startedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date time that the associated run started. Value is null if the run has not started.
format: date-time
nullable: true
successfulUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The number of users in the run execution for which the associated task succeeded.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: int32
totalUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The total number of users in the run execution for which the associated task was scheduled to execute.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: int32
unprocessedUsersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The number of users in the run execution for which the associated task is queued, in progress, or canceled.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: int32
task:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
taskDefinition:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskDefinition'
taskProcessingResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
description: The related lifecycle workflow taskProcessingResults.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: taskDefinition
type: object
properties:
category:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleTaskCategory'
continueOnError:
type: boolean
description: Defines if the workflow will continue if the task has an error.
description:
type: string
description: The description of the taskDefinition.
nullable: true
displayName:
type: string
description: 'The display name of the taskDefinition.Supports $filter(eq, ne) and $orderby.'
parameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.parameter'
description: The parameters that must be supplied when creating a workflow task object.Supports $filter(any).
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The version number of the taskDefinition. New records are pushed when we add support for new parameters.Supports $filter(ge, gt, le, lt, eq, ne) and $orderby.'
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskReportSummary:
title: taskReportSummary
type: object
properties:
failedTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of failed tasks in a report.
format: int32
successfulTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of successful tasks in a report.
format: int32
totalTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of tasks in a report.
format: int32
unprocessedTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of unprocessed tasks in a report.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowBase'
- title: workflowVersion
type: object
properties:
settings:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowSetting'
versionNumber:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The version of the workflow.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.'
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.insights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: insights
type: object
additionalProperties:
type: object
microsoft.graph.identityGovernance.topTasksInsightsSummary:
title: topTasksInsightsSummary
type: object
properties:
failedTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed runs of the task.
format: int32
failedUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed users who were processed by the task.
format: int32
successfulTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful runs of the task.
format: int32
successfulUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful users processed by the task.
format: int32
taskDefinitionDisplayName:
type: string
description: The name of the task.
taskDefinitionId:
type: string
description: The task ID.
totalTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of total runs of the task.
format: int32
totalUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of total users processed by the task.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.topWorkflowsInsightsSummary:
title: topWorkflowsInsightsSummary
type: object
properties:
failedRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed runs for workflow.
format: int32
failedUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed users who were processed.
format: int32
successfulRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful runs of the workflow.
format: int32
successfulUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful users processed by the workflow.
format: int32
totalRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of total runs of workflow.
format: int32
totalUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Total number of users processed by the workflow.
format: int32
workflowCategory:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowCategory'
workflowDisplayName:
type: string
description: The name of the workflow.
workflowId:
type: string
description: The workflow ID.
workflowVersion:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the workflow that was a top workflow ran.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowsInsightsByCategory:
title: workflowsInsightsByCategory
type: object
properties:
failedJoinerRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Failed 'Joiner' workflows processed in a tenant.
format: int32
failedLeaverRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Failed 'Leaver' workflows processed in a tenant.
format: int32
failedMoverRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Failed 'Mover' workflows processed in a tenant.
format: int32
successfulJoinerRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Successful 'Joiner' workflows processed in a tenant.
format: int32
successfulLeaverRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Successful 'Leaver' workflows processed in a tenant.
format: int32
successfulMoverRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Successful 'Mover' workflows processed in a tenant.
format: int32
totalJoinerRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Total 'Joiner' workflows processed in a tenant.
format: int32
totalLeaverRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Total 'Leaver' workflows processed in a tenant.
format: int32
totalMoverRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Total 'Mover' workflows processed in a tenant.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowsInsightsSummary:
title: workflowsInsightsSummary
type: object
properties:
failedRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed workflow runs processed in the tenant.
format: int32
failedTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed tasks processed in the tenant.
format: int32
failedUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of failed users processed by workflows in the tenant.
format: int32
successfulRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful workflow runs processed in the tenant.
format: int32
successfulTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful tasks processed in the tenant.
format: int32
successfulUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of successful users processed by workflows in the tenant.
format: int32
totalRuns:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of total workflows processed in the tenant.
format: int32
totalTasks:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of total tasks processed by workflows in the tenant.
format: int32
totalUsers:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of total users processed by workflows in the tenant.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.lifecycleManagementSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: lifecycleManagementSettings
type: object
properties:
emailSettings:
$ref: '#/components/schemas/microsoft.graph.emailSettings'
quarantineConfiguration:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration'
workflowScheduleIntervalInHours:
maximum: 2147483647
minimum: -2147483648
type: number
description: The interval in hours at which all workflows running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24. The default value is 3 hours.
format: int32
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workflowTemplate
type: object
properties:
category:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowCategory'
description:
type: string
description: The description of the workflowTemplate.
nullable: true
displayName:
type: string
description: 'The display name of the workflowTemplate.Supports $filter(eq, ne) and $orderby.'
executionConditions:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowExecutionConditions'
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
description: Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: privilegedAccessRoot
type: object
properties:
group:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroup'
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: privilegedAccessGroup
type: object
properties:
assignmentApprovals:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
x-ms-navigationProperty: true
assignmentScheduleInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
description: The instances of assignment schedules to activate a just-in-time access.
x-ms-navigationProperty: true
assignmentScheduleRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
description: 'The schedule requests for operations to create, update, delete, extend, and renew an assignment.'
x-ms-navigationProperty: true
assignmentSchedules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
description: The assignment schedules to activate a just-in-time access.
x-ms-navigationProperty: true
eligibilityScheduleInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
description: The instances of eligibility schedules to activate a just-in-time access.
x-ms-navigationProperty: true
eligibilityScheduleRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
description: 'The schedule requests for operations to create, update, delete, extend, and renew an eligibility.'
x-ms-navigationProperty: true
eligibilitySchedules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
description: The eligibility schedules to activate a just-in-time access.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.privilegedAccessScheduleInstance'
- title: privilegedAccessGroupAssignmentScheduleInstance
type: object
properties:
accessId:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupRelationships'
assignmentScheduleId:
type: string
description: 'The identifier of the privilegedAccessGroupAssignmentSchedule from which this instance was created. Required. Supports $filter (eq, ne).'
nullable: true
assignmentType:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentType'
groupId:
type: string
description: The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Optional. Supports $filter (eq).
nullable: true
memberType:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupMemberType'
principalId:
type: string
description: The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Required. Supports $filter (eq).
nullable: true
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
group:
$ref: '#/components/schemas/microsoft.graph.group'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.privilegedAccessScheduleInstance'
- title: privilegedAccessGroupEligibilityScheduleInstance
type: object
properties:
accessId:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupRelationships'
eligibilityScheduleId:
type: string
description: 'The identifier of the privilegedAccessGroupEligibilitySchedule from which this instance was created. Required. Supports $filter (eq, ne).'
nullable: true
groupId:
type: string
description: The identifier of the group representing the scope of the membership or ownership eligibility through PIM for Groups. Required. Supports $filter (eq).
nullable: true
memberType:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupMemberType'
principalId:
type: string
description: The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for Groups. Required. Supports $filter (eq).
nullable: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
additionalProperties:
type: object
microsoft.graph.group:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: group
type: object
properties:
accessType:
$ref: '#/components/schemas/microsoft.graph.groupAccessType'
allowExternalSenders:
type: boolean
description: 'Indicates if people external to the organization can send messages to the group. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
assignedLabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLabel'
description: 'The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group or a cloud security group. Requires a Microsoft Entra ID P1 license. Requires $select to retrieve. This property can be specified during group creation or update. However, for cloud security groups, it''s immutable once set. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role. See Key differences from Microsoft 365 group labeling to learn more about managing this property for Microsoft 365 vs. cloud security groups.'
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: The licenses that are assigned to the group. Requires $select to retrieve. Supports $filter (eq). Read-only.
autoSubscribeNewMembers:
type: boolean
description: 'Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don''t set it in the initial POST request that creates the group. Default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
classification:
type: string
description: 'Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of when the group was created. The value can''t be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.'
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.'
nullable: true
displayName:
type: string
description: 'The display name for the group. This property is required when a group is created and can''t be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of when the group is set to expire. It''s null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
groupTypes:
type: array
items:
type: string
description: 'Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it''s either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).'
hasMembersWithLicenseErrors:
type: boolean
description: 'Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).'
nullable: true
hideFromAddressLists:
type: boolean
description: 'True if the group isn''t displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
hideFromOutlookClients:
type: boolean
description: 'True if the group isn''t displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
infoCatalogs:
type: array
items:
type: string
isArchived:
type: boolean
description: 'When a group is associated with a team, this property determines whether the team is in read-only mode.To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.'
nullable: true
isAssignableToRole:
type: boolean
description: 'Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group can''t be a dynamic group (that is, groupTypes can''t contain DynamicMembership). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignmentsUsing this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not).'
nullable: true
isFavorite:
type: boolean
description: 'Indicates whether the user marked the group as favorite. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
isManagementRestricted:
type: boolean
description: 'Indicates whether the group is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve.'
nullable: true
isSubscribedByMail:
type: boolean
description: 'Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
licenseProcessingState:
$ref: '#/components/schemas/microsoft.graph.licenseProcessingState'
mail:
type: string
description: 'The SMTP address for the group, for example, ''serviceadmins@contoso.com''. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mailEnabled:
type: boolean
description: 'Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).'
nullable: true
mailNickname:
type: string
description: 'The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () / [] '' ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
membershipRule:
type: string
description: 'The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
nullable: true
membershipRuleProcessingState:
type: string
description: 'Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
onPremisesDomainName:
type: string
description: 'Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesLastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesNetBiosName:
type: string
description: Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).'
onPremisesSamAccountName:
type: string
description: 'Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.'
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
organizationId:
type: string
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator''s preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles: User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
proxyAddresses:
type: array
items:
type: string
description: 'Email addresses for the group that direct to the same group mailbox. For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
renewedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of when the group was last renewed. This value can''t be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
resourceBehaviorOptions:
type: array
items:
type: string
description: 'Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This property can be set only as part of creation (POST). For the list of possible values, see Microsoft 365 group behaviors and provisioning options.'
resourceProvisioningOptions:
type: array
items:
type: string
description: 'Specifies the group resources that are associated with the Microsoft 365 group. The possible value is Team. For more information, see Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith).'
securityEnabled:
type: boolean
description: 'Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
securityIdentifier:
type: string
description: 'Security identifier of the group, used in Windows scenarios. Read-only. Returned by default.'
nullable: true
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
theme:
type: string
description: 'Specifies a Microsoft 365 group''s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default.'
nullable: true
uniqueName:
type: string
description: The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only.
nullable: true
unseenConversationsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Count of conversations that have had one or more new posts delivered since the signed-in user''s last visit to the group. This property is the same as unseenCount. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
unseenCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Count of conversations that have received new posts since the signed-in user last visited the group. This property is the same as unseenConversationsCount.Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
unseenMessagesCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Count of new posts that have been delivered to the group''s conversations since the signed-in user''s last visit to the group. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
visibility:
type: string
description: 'Specifies the group join policy and group content visibility for groups. The possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can''t be updated later. Other values of visibility can be updated after group creation. If visibility value isn''t specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable.'
nullable: true
welcomeMessageEnabled:
type: boolean
nullable: true
acceptedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The list of users or groups allowed to create posts or calendar events in this group. If this list is nonempty, then only users or groups listed here are allowed to post.'
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles granted to a group for an application. Supports $expand.
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only.
x-ms-navigationProperty: true
conversations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversation'
description: The group's conversations.
x-ms-navigationProperty: true
createdOnBehalfOf:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The group's drives. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The group's calendar events.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the group. Read-only. Nullable.
x-ms-navigationProperty: true
groupLifecyclePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
description: The collection of lifecycle policies for this group. Read-only. Nullable.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
membersWithLicenseErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: A list of group members with license errors from this group-based license assignment. Read-only.
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
onPremisesSyncBehavior:
$ref: '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. If this property isn''t specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. A non-admin user can''t explicitly add themselves to this collection when they''re creating the group. For more information, see the related known issue. For security groups, the admin user isn''t automatically added to this collection. For more information, see the related known issue. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The profile photos owned by the group. Read-only. Nullable.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerGroup'
rejectedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The list of users or groups not allowed to create posts or calendar events in this group. Nullable
x-ms-navigationProperty: true
settings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
description: 'Settings that can govern this group''s behavior, like whether members can invite guests to the group. Nullable.'
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The list of SharePoint sites in this group. Access the default site with /sites/root.
x-ms-navigationProperty: true
team:
$ref: '#/components/schemas/microsoft.graph.team'
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: The group's conversation threads. Nullable.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups that a group is a member of, either directly or through nested membership. Nullable.'
x-ms-navigationProperty: true
transitiveMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The direct and transitive members of a group. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.assignmentScheduleInstanceFilterByCurrentUserOptions:
title: assignmentScheduleInstanceFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.privilegedAccessScheduleRequest'
- title: privilegedAccessGroupAssignmentScheduleRequest
type: object
properties:
accessId:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupRelationships'
groupId:
type: string
description: The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Required.
nullable: true
principalId:
type: string
description: 'The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Supports $filter (eq, ne).'
nullable: true
targetScheduleId:
type: string
description: 'The identifier of the schedule that''s created from the membership or ownership assignment request. Supports $filter (eq, ne).'
nullable: true
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
group:
$ref: '#/components/schemas/microsoft.graph.group'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
targetSchedule:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupEligibilitySchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.privilegedAccessSchedule'
- title: privilegedAccessGroupEligibilitySchedule
type: object
properties:
accessId:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupRelationships'
groupId:
type: string
description: The identifier of the group representing the scope of the membership or ownership eligibility through PIM for Groups. Required. Supports $filter (eq).
nullable: true
memberType:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupMemberType'
principalId:
type: string
description: The identifier of the principal whose membership or ownership eligibility is granted through PIM for Groups. Required. Supports $filter (eq).
nullable: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
additionalProperties:
type: object
microsoft.graph.assignmentScheduleRequestFilterByCurrentUserOptions:
title: assignmentScheduleRequestFilterByCurrentUserOptions
enum:
- principal
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.privilegedAccessGroupAssignmentSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.privilegedAccessSchedule'
- title: privilegedAccessGroupAssignmentSchedule
type: object
properties:
accessId:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupRelationships'
assignmentType:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentType'
groupId:
type: string
description: The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Required. Supports $filter (eq).
nullable: true
memberType:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupMemberType'
principalId:
type: string
description: The identifier of the principal whose membership or ownership assignment is granted through PIM for Groups. Required. Supports $filter (eq).
nullable: true
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
group:
$ref: '#/components/schemas/microsoft.graph.group'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
additionalProperties:
type: object
microsoft.graph.assignmentScheduleFilterByCurrentUserOptions:
title: assignmentScheduleFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.eligibilityScheduleInstanceFilterByCurrentUserOptions:
title: eligibilityScheduleInstanceFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.privilegedAccessScheduleRequest'
- title: privilegedAccessGroupEligibilityScheduleRequest
type: object
properties:
accessId:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupRelationships'
groupId:
type: string
description: The identifier of the group representing the scope of the membership and ownership eligibility through PIM for Groups. Required.
nullable: true
principalId:
type: string
description: The identifier of the principal whose membership or ownership eligibility to the group is managed through PIM for Groups. Required.
nullable: true
targetScheduleId:
type: string
description: The identifier of the schedule that's created from the eligibility request. Optional.
nullable: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
targetSchedule:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
additionalProperties:
type: object
microsoft.graph.eligibilityScheduleRequestFilterByCurrentUserOptions:
title: eligibilityScheduleRequestFilterByCurrentUserOptions
enum:
- principal
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.eligibilityScheduleFilterByCurrentUserOptions:
title: eligibilityScheduleFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.termsOfUseContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: termsOfUseContainer
type: object
properties:
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: Represents the current status of a user's response to a company's customizable terms of use agreement.
x-ms-navigationProperty: true
agreements:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreement'
description: Represents a tenant's customizable terms of use agreement that's created and managed with Microsoft Entra ID Governance.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.rbacApplication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: rbacApplication
type: object
properties:
resourceNamespaces:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
x-ms-navigationProperty: true
roleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
description: Resource to grant access to users or groups.
x-ms-navigationProperty: true
roleAssignmentScheduleInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
description: Instances for active role assignments.
x-ms-navigationProperty: true
roleAssignmentScheduleRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
description: Requests for active role assignments to principals through PIM.
x-ms-navigationProperty: true
roleAssignmentSchedules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
description: Schedules for active role assignment operations.
x-ms-navigationProperty: true
roleDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
description: Resource representing the roles allowed by RBAC providers and the permissions assigned to the roles.
x-ms-navigationProperty: true
roleEligibilityScheduleInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
description: Instances for role eligibility requests.
x-ms-navigationProperty: true
roleEligibilityScheduleRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
description: Requests for role eligibilities for principals through PIM.
x-ms-navigationProperty: true
roleEligibilitySchedules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
description: Schedules for role eligibility operations.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceNamespace:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRbacResourceNamespace
type: object
properties:
name:
type: string
resourceActions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceAction:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRbacResourceAction
type: object
properties:
actionVerb:
type: string
nullable: true
authenticationContextId:
type: string
nullable: true
description:
type: string
nullable: true
isAuthenticationContextSettable:
type: boolean
nullable: true
name:
type: string
resourceScopeId:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleAssignment
type: object
properties:
appScopeId:
type: string
description: 'Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, /AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997. Supports $filter (eq, in). For example, /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq ''/AccessPackageCatalog/{catalog id}''.'
nullable: true
condition:
type: string
nullable: true
directoryScopeId:
type: string
description: 'Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in).'
nullable: true
principalId:
type: string
description: 'Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports $filter (eq, in).'
nullable: true
principalOrganizationId:
type: string
nullable: true
roleDefinitionId:
type: string
description: 'Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in).'
nullable: true
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
additionalProperties:
type: object
microsoft.graph.appScope:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: appScope
type: object
properties:
displayName:
type: string
description: Provides the display name of the app-specific resource represented by the app scope. Read-only.
nullable: true
type:
type: string
description: Describes the type of app-specific resource represented by the app scope. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleDefinition
type: object
properties:
description:
type: string
description: The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true.
nullable: true
displayName:
type: string
description: 'The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in).'
nullable: true
isBuiltIn:
type: boolean
description: 'Flag indicating whether the role definition is part of the default set included in Microsoft Entra or a custom definition. Read-only. Supports $filter (eq, in).'
nullable: true
isEnabled:
type: boolean
description: Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.
nullable: true
resourceScopes:
type: array
items:
type: string
description: 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:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRolePermission'
description: List of permissions included in the role. Read-only when isBuiltIn is true. Required.
templateId:
type: string
description: 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.
nullable: true
version:
type: string
description: Indicates version of the role definition. Read-only when isBuiltIn is true.
nullable: true
inheritsPermissionsFrom:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
description: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleInstanceBase'
- title: unifiedRoleAssignmentScheduleInstance
type: object
properties:
assignmentType:
type: string
description: 'The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne).'
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The end date of the schedule instance.
format: date-time
nullable: true
memberType:
type: string
description: 'How the assignment is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
roleAssignmentOriginId:
type: string
description: 'The identifier of the role assignment in Microsoft Entra. Supports $filter (eq, ne).'
nullable: true
roleAssignmentScheduleId:
type: string
description: 'The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created. Supports $filter (eq, ne).'
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When this instance starts.
format: date-time
nullable: true
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleInstanceBase'
- title: unifiedRoleEligibilityScheduleInstance
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The end date of the schedule instance.
format: date-time
nullable: true
memberType:
type: string
description: 'How the role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
roleEligibilityScheduleId:
type: string
description: 'The identifier of the unifiedRoleEligibilitySchedule object from which this instance was created. Supports $filter (eq, ne).'
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When this instance starts.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.roleAssignmentScheduleInstanceFilterByCurrentUserOptions:
title: roleAssignmentScheduleInstanceFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.unifiedRoleAssignmentScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: unifiedRoleAssignmentScheduleRequest
type: object
properties:
action:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleRequestActions'
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment is scoped to an app. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, ne, and on null values).'
nullable: true
directoryScopeId:
type: string
description: 'Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, ne, and on null values).'
nullable: true
isValidationOnly:
type: boolean
description: Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
nullable: true
justification:
type: string
description: A message provided by users and administrators when create they create the unifiedRoleAssignmentScheduleRequest object.
nullable: true
principalId:
type: string
description: 'Identifier of the principal that has been granted the assignment. Can be a user, role-assignable group, or a service principal. Supports $filter (eq, ne).'
nullable: true
roleDefinitionId:
type: string
description: 'Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
targetScheduleId:
type: string
description: 'Identifier of the schedule object that''s linked to the assignment request. Supports $filter (eq, ne).'
nullable: true
ticketInfo:
$ref: '#/components/schemas/microsoft.graph.ticketInfo'
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
targetSchedule:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilitySchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleBase'
- title: unifiedRoleEligibilitySchedule
type: object
properties:
memberType:
type: string
description: 'How the role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleBase'
- title: unifiedRoleAssignmentSchedule
type: object
properties:
assignmentType:
type: string
description: 'The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne).'
nullable: true
memberType:
type: string
description: 'How the assignment is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
additionalProperties:
type: object
microsoft.graph.roleAssignmentScheduleRequestFilterByCurrentUserOptions:
title: roleAssignmentScheduleRequestFilterByCurrentUserOptions
enum:
- principal
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.roleAssignmentScheduleFilterByCurrentUserOptions:
title: roleAssignmentScheduleFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.roleEligibilityScheduleInstanceFilterByCurrentUserOptions:
title: roleEligibilityScheduleInstanceFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.unifiedRoleEligibilityScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: unifiedRoleEligibilityScheduleRequest
type: object
properties:
action:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleRequestActions'
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of a role eligibility determines the set of resources for which the principal is eligible to access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, ne, and on null values).'
nullable: true
directoryScopeId:
type: string
description: 'Identifier of the directory object representing the scope of the role eligibility. The scope of a role eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, ne, and on null values).'
nullable: true
isValidationOnly:
type: boolean
description: Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
nullable: true
justification:
type: string
description: A message provided by users and administrators when create they create the unifiedRoleEligibilityScheduleRequest object.
nullable: true
principalId:
type: string
description: 'Identifier of the principal that has been granted the role eligibility. Can be a user or a role-assignable group. You can grant only active assignments service principals.Supports $filter (eq, ne).'
nullable: true
roleDefinitionId:
type: string
description: 'Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
targetScheduleId:
type: string
description: 'Identifier of the schedule object that''s linked to the eligibility request. Supports $filter (eq, ne).'
nullable: true
ticketInfo:
$ref: '#/components/schemas/microsoft.graph.ticketInfo'
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
targetSchedule:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
additionalProperties:
type: object
microsoft.graph.roleEligibilityScheduleRequestFilterByCurrentUserOptions:
title: roleEligibilityScheduleRequestFilterByCurrentUserOptions
enum:
- principal
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.roleEligibilityScheduleFilterByCurrentUserOptions:
title: roleEligibilityScheduleFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.entity:
title: entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
additionalProperties:
type: object
microsoft.graph.termsExpiration:
title: termsExpiration
type: object
properties:
frequency:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'Represents the frequency at which the terms will expire, after its first expiration as set in startDateTime. The value is represented in ISO 8601 format for durations. For example, PT1M represents a time period of one month.'
format: duration
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The DateTime when the agreement is set to expire for all users. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementAcceptanceState:
title: agreementAcceptanceState
enum:
- accepted
- declined
- unknownFutureValue
type: string
microsoft.graph.agreementFileProperties:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementFileProperties
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time representing when the file was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
displayName:
type: string
description: Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
nullable: true
fileData:
$ref: '#/components/schemas/microsoft.graph.agreementFileData'
fileName:
type: string
description: 'Name of the agreement file (for example, TOU.pdf). Read-only.'
nullable: true
isDefault:
type: boolean
description: 'If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only.'
nullable: true
isMajorVersion:
type: boolean
description: Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
nullable: true
language:
type: string
description: 'The language of the agreement file in the format ''languagecode2-country/regioncode2''. ''languagecode2'' is a lowercase two-letter code derived from ISO 639-1, while ''country/regioncode2'' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewNotificationRecipientItem:
title: accessReviewNotificationRecipientItem
type: object
properties:
notificationRecipientScope:
$ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientScope'
notificationTemplateType:
type: string
description: 'Indicates the type of access review email to be sent. Supported template type is CompletedAdditionalRecipients, which sends review completion notifications to the recipients.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: userIdentity
type: object
properties:
ipAddress:
type: string
description: Indicates the client IP address associated with the user performing the activity (audit log only).
nullable: true
userPrincipalName:
type: string
description: The userPrincipalName attribute of the user.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewReviewerScope:
title: accessReviewReviewerScope
type: object
properties:
query:
type: string
description: The query specifying who will be the reviewer.
nullable: true
queryRoot:
type: string
description: 'In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.'
nullable: true
queryType:
type: string
description: The type of query. Examples include MicrosoftGraph and ARM.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewScope:
title: accessReviewScope
type: object
additionalProperties:
type: object
microsoft.graph.accessReviewScheduleSettings:
title: accessReviewScheduleSettings
type: object
properties:
applyActions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewApplyAction'
description: 'Optional field. Describes the actions to take once a review is complete. There are two types that are currently supported: removeAccessApplyAction (default) and disableAndDeleteUserApplyAction. Field only needs to be specified in the case of disableAndDeleteUserApplyAction.'
autoApplyDecisionsEnabled:
type: boolean
description: 'Indicates whether decisions are automatically applied. When set to false, an admin must apply the decisions manually once the reviewer completes the access review. When set to true, decisions are applied automatically after the access review instance duration ends, whether or not the reviewers have responded. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.'
decisionHistoriesForReviewersEnabled:
type: boolean
description: 'Indicates whether decisions on previous access review stages are available for reviewers on an accessReviewInstance with multiple subsequent stages. If not provided, the default is disabled (false).'
nullable: true
defaultDecision:
type: string
description: 'Decision chosen if defaultDecisionEnabled is enabled. Can be one of Approve, Deny, or Recommendation.'
nullable: true
defaultDecisionEnabled:
type: boolean
description: 'Indicates whether the default decision is enabled or disabled when reviewers do not respond. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.'
instanceDurationInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Duration of an access review instance in days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its durationInDays setting will be used instead of the value of this property.'
format: int32
justificationRequiredOnApproval:
type: boolean
description: Indicates whether reviewers are required to provide justification with their decision. Default value is false.
mailNotificationsEnabled:
type: boolean
description: Indicates whether emails are enabled or disabled. Default value is false.
recommendationInsightSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewRecommendationInsightSetting'
description: 'Optional. Describes the types of insights that aid reviewers to make access review decisions. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationInsightSettings setting will be used instead of the value of this property.'
recommendationLookBackDuration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'Optional field. Indicates the period of inactivity (with respect to the start date of the review instance) that recommendations will be configured from. The recommendation will be to deny if the user is inactive during the look-back duration. For reviews of groups and Microsoft Entra roles, any duration is accepted. For reviews of applications, 30 days is the maximum duration. If not specified, the duration is 30 days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationLookBackDuration setting will be used instead of the value of this property.'
format: duration
nullable: true
recommendationsEnabled:
type: boolean
description: 'Indicates whether decision recommendations are enabled or disabled. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationsEnabled setting will be used instead of the value of this property.'
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderNotificationsEnabled:
type: boolean
description: Indicates whether reminders are enabled or disabled. Default value is false.
additionalProperties:
type: object
microsoft.graph.accessReviewStageSettings:
title: accessReviewStageSettings
type: object
properties:
decisionsThatWillMoveToNextStage:
type: array
items:
type: string
nullable: true
description: 'Indicate which decisions will go to the next stage. Can be a subset of Approve, Deny, Recommendation, or NotReviewed. If not provided, all decisions will go to the next stage. Optional.'
dependsOn:
type: array
items:
type: string
description: 'Defines the sequential or parallel order of the stages and depends on the stageId. Only sequential stages are currently supported. For example, if stageId is 2, then dependsOn must be 1. If stageId is 1, don''t specify dependsOn. Required if stageId isn''t 1.'
durationInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The duration of the stage. Required. NOTE: The cumulative value of this property across all stages 1. Will override the instanceDurationInDays setting on the accessReviewScheduleDefinition object. 2. Can''t exceed the length of one recurrence. That is, if the review recurs weekly, the cumulative durationInDays can''t exceed 7.'
format: int32
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'If provided, the fallback reviewers are asked to complete a review if the primary reviewers don''t exist. For example, if managers are selected as reviewers and a principal under review doesn''t have a manager in Microsoft Entra ID, the fallback reviewers are asked to review that principal. NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.'
recommendationInsightSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewRecommendationInsightSetting'
recommendationsEnabled:
type: boolean
description: 'Indicates whether showing recommendations to reviewers is enabled. Required. NOTE: The value of this property overrides override the corresponding setting on the accessReviewScheduleDefinition object.'
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'Defines who the reviewers are. If none is specified, the review is a self-review (users review their own access). For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition.'
stageId:
type: string
description: Unique identifier of the accessReviewStageSettings object. The stageId is used by the dependsOn property to indicate the order of the stages. Required.
additionalProperties:
type: object
microsoft.graph.identity:
title: identity
type: object
properties:
displayName:
type: string
description: 'The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
nullable: true
id:
type: string
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItemResource:
title: accessReviewInstanceDecisionItemResource
type: object
properties:
displayName:
type: string
description: Display name of the resource
nullable: true
id:
type: string
description: Identifier of the resource
nullable: true
type:
type: string
description: 'Type of resource. Types include: Group, ServicePrincipal, DirectoryRole, AzureRole, AccessPackageAssignmentPolicy.'
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryDecisionFilter:
title: accessReviewHistoryDecisionFilter
enum:
- approve
- deny
- notReviewed
- dontKnow
- notNotified
- unknownFutureValue
type: string
microsoft.graph.accessReviewHistoryScheduleSettings:
title: accessReviewHistoryScheduleSettings
type: object
properties:
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reportRange:
type: string
description: 'A duration string in ISO 8601 duration format specifying the lookback period of the generated review history data. For example, if a history definition is scheduled to run on the first of every month, the reportRange is P1M. In this case, on the first of every month, access review history data is collected containing only the previous month''s review data. Note: Only years, months, and days ISO 8601 properties are supported. Required.'
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryStatus:
title: accessReviewHistoryStatus
enum:
- done
- inprogress
- error
- requested
- unknownFutureValue
type: string
microsoft.graph.appConsentRequestScope:
title: appConsentRequestScope
type: object
properties:
displayName:
type: string
description: The name of the scope.
nullable: true
additionalProperties:
type: object
microsoft.graph.request:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: request
type: object
properties:
approvalId:
type: string
description: The identifier of the approval of the request.
nullable: true
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The request completion date time.
format: date-time
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The request creation date time.
format: date-time
nullable: true
customData:
type: string
description: Free text field to define any custom data for the request. Not used.
nullable: true
status:
type: string
description: 'The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.'
additionalProperties:
type: object
microsoft.graph.accessPackageCatalogType:
title: accessPackageCatalogType
enum:
- userManaged
- serviceDefault
- serviceManaged
- unknownFutureValue
type: string
microsoft.graph.accessPackageCatalogState:
title: accessPackageCatalogState
enum:
- unpublished
- published
- unknownFutureValue
type: string
microsoft.graph.customExtensionAuthenticationConfiguration:
title: customExtensionAuthenticationConfiguration
type: object
additionalProperties:
type: object
microsoft.graph.customExtensionClientConfiguration:
title: customExtensionClientConfiguration
type: object
properties:
maximumRetries:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The max number of retries that Microsoft Entra ID makes to the external API. Values of 0 or 1 are supported. If null, the default for the service applies.'
format: int32
nullable: true
timeoutInMilliseconds:
maximum: 2147483647
minimum: -2147483648
type: number
description: The max duration in milliseconds that Microsoft Entra ID waits for a response from the external app before it shuts down the connection. The valid range is between 200 and 2000 milliseconds. Default duration is 1000.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.customExtensionEndpointConfiguration:
title: customExtensionEndpointConfiguration
type: object
additionalProperties:
type: object
microsoft.graph.roleType:
title: roleType
enum:
- active
- eligible
- application
- delegated
- unknownFutureValue
type: string
microsoft.graph.accessPackageResourceAttribute:
title: accessPackageResourceAttribute
type: object
properties:
destination:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceAttributeDestination'
isEditable:
type: boolean
nullable: true
isPersistedOnAssignmentRemoval:
type: boolean
nullable: true
name:
type: string
description: 'The name of the attribute in the end system. If the destination is accessPackageUserDirectoryAttributeStore, then a user property such as jobTitle or a directory schema extension for the user object type, such as extension2b676109c7c74ae2b41549205f1947edpersonalTitle.'
nullable: true
source:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceAttributeSource'
additionalProperties:
type: object
microsoft.graph.connectionInfo:
title: connectionInfo
type: object
properties:
url:
type: string
description: The endpoint that is used by Entitlement Management to communicate with the access package resource.
nullable: true
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourcePayloads.data:
title: data
type: object
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourceUploadStats:
title: customDataProvidedResourceUploadStats
type: object
properties:
filesUploaded:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of files uploaded in this session.
format: int32
totalBytesUploaded:
type: number
description: Total bytes uploaded in this session.
format: int64
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourceUploadStatus:
title: customDataProvidedResourceUploadStatus
enum:
- active
- complete
- expired
- unknownFutureValue
type: string
microsoft.graph.allowedTargetScope:
title: allowedTargetScope
enum:
- notSpecified
- specificDirectoryUsers
- specificConnectedOrganizationUsers
- specificDirectoryServicePrincipals
- allMemberUsers
- allDirectoryUsers
- allDirectoryServicePrincipals
- allConfiguredConnectedOrganizationUsers
- allExternalUsers
- allDirectoryAgentIdentities
- unknownFutureValue
type: string
microsoft.graph.accessPackageAutomaticRequestSettings:
title: accessPackageAutomaticRequestSettings
type: object
properties:
gracePeriodBeforeAccessRemoval:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: The duration for which access must be retained before the target's access is revoked once they leave the allowed target scope.
format: duration
nullable: true
removeAccessWhenTargetLeavesAllowedTargets:
type: boolean
description: Indicates whether automatic assignment must be removed for targets who move out of the allowed target scope.
nullable: true
requestAccessForAllowedTargets:
type: boolean
description: 'If set to true, automatic assignments will be created for targets in the allowed target scope.'
nullable: true
additionalProperties:
type: object
microsoft.graph.expirationPattern:
title: expirationPattern
type: object
properties:
duration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'The requestor''s desired duration of access represented in ISO 8601 format for durations. For example, PT3H refers to three hours. If specified in a request, endDateTime should not be present and the type property should be set to afterDuration.'
format: duration
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.expirationPatternType'
additionalProperties:
type: object
microsoft.graph.accessPackageNotificationSettings:
title: accessPackageNotificationSettings
type: object
properties:
isAssignmentNotificationDisabled:
type: boolean
description: Indicates if notification emails for an access package are disabled within an access package assignment policy.
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentApprovalSettings:
title: accessPackageAssignmentApprovalSettings
type: object
properties:
isApprovalRequiredForAdd:
type: boolean
description: 'If false, then approval isn''t required for new requests in this policy.'
nullable: true
isApprovalRequiredForUpdate:
type: boolean
description: 'If false, then approval isn''t required for updates to requests in this policy.'
nullable: true
isRequestorJustificationRequired:
type: boolean
description: 'If false, then requestor justification isn''t required for updates to requests in this policy.'
nullable: true
stages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageApprovalStage'
description: 'If approval is required, the one, two or three elements of this collection define each of the stages of approval. An empty array is present if no approval is required.'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestorSettings:
title: accessPackageAssignmentRequestorSettings
type: object
properties:
allowCustomAssignmentSchedule:
type: boolean
description: False indicates that the requestor isn't permitted to include a schedule in their request.
nullable: true
enableOnBehalfRequestorsToAddAccess:
type: boolean
description: True allows on-behalf-of requestors to create a request to add access for another principal.
nullable: true
enableOnBehalfRequestorsToRemoveAccess:
type: boolean
description: True allows on-behalf-of requestors to create a request to remove access for another principal.
nullable: true
enableOnBehalfRequestorsToUpdateAccess:
type: boolean
description: True allows on-behalf-of requestors to create a request to update access for another principal.
nullable: true
enableTargetsToSelfAddAccess:
type: boolean
description: True allows requestors to create a request to add access for themselves.
nullable: true
enableTargetsToSelfRemoveAccess:
type: boolean
description: True allows requestors to create a request to remove their access.
nullable: true
enableTargetsToSelfUpdateAccess:
type: boolean
description: True allows requestors to create a request to update their access.
nullable: true
onBehalfRequestors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: The principals who can request on-behalf-of others.
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentReviewSettings:
title: accessPackageAssignmentReviewSettings
type: object
properties:
expirationBehavior:
$ref: '#/components/schemas/microsoft.graph.accessReviewExpirationBehavior'
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: This collection specifies the users who will be the fallback reviewers when the primary reviewers don't respond.
isEnabled:
type: boolean
description: 'If true, access reviews are required for assignments through this policy.'
nullable: true
isRecommendationEnabled:
type: boolean
description: Specifies whether to display recommendations to the reviewer. The default value is true.
nullable: true
isReviewerJustificationRequired:
type: boolean
description: Specifies whether the reviewer must provide justification for the approval. The default value is true.
nullable: true
isSelfReview:
type: boolean
description: Specifies whether the principals can review their own assignments.
nullable: true
primaryReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: This collection specifies the users or group of users who will review the access package assignments.
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
additionalProperties:
type: object
microsoft.graph.subjectSet:
title: subjectSet
type: object
additionalProperties:
type: object
microsoft.graph.accessPackageCustomExtensionStage:
title: accessPackageCustomExtensionStage
enum:
- assignmentRequestCreated
- assignmentRequestApproved
- assignmentRequestGranted
- assignmentRequestRemoved
- assignmentFourteenDaysBeforeExpiration
- assignmentOneDayBeforeExpiration
- unknownFutureValue
type: string
microsoft.graph.accessPackageLocalizedText:
title: accessPackageLocalizedText
type: object
properties:
languageCode:
type: string
description: 'The language code that text is in. For example, ''en-us''. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2. Required.'
text:
type: string
description: The question in the specific language. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.entitlementManagementSchedule:
title: entitlementManagementSchedule
type: object
properties:
expiration:
$ref: '#/components/schemas/microsoft.graph.expirationPattern'
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageSuggestionReason:
title: accessPackageSuggestionReason
type: object
additionalProperties:
type: object
microsoft.graph.accessPackageAnswer:
title: accessPackageAnswer
type: object
properties:
displayValue:
type: string
description: The localized display value shown to the requestor and approvers.
nullable: true
answeredQuestion:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
additionalProperties:
type: object
microsoft.graph.customExtensionCalloutInstance:
title: customExtensionCalloutInstance
type: object
properties:
customExtensionId:
type: string
description: Identification of the custom extension that was triggered at this instance.
nullable: true
detail:
type: string
description: Details provided by the logic app during the callback of the request instance.
nullable: true
externalCorrelationId:
type: string
description: The unique run identifier for the logic app.
nullable: true
id:
type: string
description: Unique identifier for the callout instance. Read-only.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.customExtensionCalloutInstanceStatus'
additionalProperties:
type: object
microsoft.graph.accessPackageRequestType:
title: accessPackageRequestType
enum:
- notSpecified
- userAdd
- userUpdate
- userRemove
- adminAdd
- adminUpdate
- adminRemove
- systemAdd
- systemUpdate
- systemRemove
- onBehalfAdd
- unknownFutureValue
- approverRemove
type: string
microsoft.graph.accessPackageRequestState:
title: accessPackageRequestState
enum:
- submitted
- pendingApproval
- delivering
- delivered
- deliveryFailed
- denied
- scheduled
- canceled
- partiallyDelivered
- unknownFutureValue
type: string
microsoft.graph.accessPackageAssignmentState:
title: accessPackageAssignmentState
enum:
- delivering
- partiallyDelivered
- delivered
- expired
- deliveryFailed
- unknownFutureValue
type: string
microsoft.graph.accessPackageSubjectLifecycle:
title: accessPackageSubjectLifecycle
enum:
- notDefined
- notGoverned
- governed
- unknownFutureValue
type: string
microsoft.graph.accessPackageSubjectType:
title: accessPackageSubjectType
enum:
- notSpecified
- user
- servicePrincipal
- unknownFutureValue
type: string
microsoft.graph.identitySource:
title: identitySource
type: object
additionalProperties:
type: object
microsoft.graph.connectedOrganizationState:
title: connectedOrganizationState
enum:
- configured
- proposed
- unknownFutureValue
type: string
microsoft.graph.accessPackageExternalUserLifecycleAction:
title: accessPackageExternalUserLifecycleAction
enum:
- none
- blockSignIn
- blockSignInAndDelete
- unknownFutureValue
type: string
microsoft.graph.customExtensionCallbackConfiguration:
title: customExtensionCallbackConfiguration
type: object
properties:
timeoutDuration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'The maximum duration in ISO 8601 format that Microsoft Entra ID will wait for a resume action for the callout it sent to the logic app. The valid range for custom extensions in lifecycle workflows is five minutes to three hours. The valid range for custom extensions in entitlement management is between 5 minutes and 14 days. For example, PT3H refers to three hours, P3D refers to three days, PT10M refers to ten minutes.'
format: duration
nullable: true
additionalProperties:
type: object
microsoft.graph.assignedLicense:
title: assignedLicense
type: object
properties:
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
description: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.assignedPlan:
title: assignedPlan
type: object
properties:
assignedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
service:
type: string
description: 'The name of the service; for example, exchange.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.'
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.authorizationInfo:
title: authorizationInfo
type: object
properties:
certificateUserIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.customSecurityAttributeValue:
title: customSecurityAttributeValue
type: object
additionalProperties:
type: object
microsoft.graph.employeeOrgData:
title: employeeOrgData
type: object
properties:
costCenter:
type: string
description: The cost center associated with the user. Requires $select to retrieve. Supports $filter.
nullable: true
division:
type: string
description: The name of the division in which the user works. Requires $select to retrieve. Supports $filter.
nullable: true
additionalProperties:
type: object
microsoft.graph.objectIdentity:
title: objectIdentity
type: object
properties:
issuer:
type: string
description: 'Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn''t federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
issuerAssignedId:
type: string
description: 'Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress (or a custom string that starts with emailAddress like emailAddress1), issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _ For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
signInType:
type: string
description: 'Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity updates the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, are performed when setting or updating a userPrincipalName identity. Extra validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
additionalProperties:
type: object
microsoft.graph.licenseAssignmentState:
title: licenseAssignmentState
type: object
properties:
assignedByGroup:
type: string
description: 'Indicates whether the license is directly-assigned or inherited from a group. If directly-assigned, this field is null; if inherited through a group membership, this field contains the ID of the group. Read-Only.'
nullable: true
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
description: The service plans that are disabled in this assignment. Read-Only.
error:
type: string
description: 'License assignment failure error. If the license is assigned successfully, this field will be Null. Read-Only. The possible values are CountViolation, MutuallyExclusiveViolation, DependencyViolation, ProhibitedInUsageLocationViolation, UniquenessViolation, and Other. For more information on how to identify and resolve license assignment errors, see here.'
nullable: true
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The timestamp when the state of the license assignment was last updated.
format: date-time
nullable: true
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the SKU. Read-Only.
format: uuid
nullable: true
state:
type: string
description: 'Indicate the current state of this assignment. Read-Only. The possible values are Active, ActiveWithError, Disabled, and Error.'
nullable: true
additionalProperties:
type: object
microsoft.graph.onPremisesExtensionAttributes:
title: onPremisesExtensionAttributes
type: object
properties:
extensionAttribute1:
type: string
description: First customizable extension attribute.
nullable: true
extensionAttribute10:
type: string
description: Tenth customizable extension attribute.
nullable: true
extensionAttribute11:
type: string
description: Eleventh customizable extension attribute.
nullable: true
extensionAttribute12:
type: string
description: Twelfth customizable extension attribute.
nullable: true
extensionAttribute13:
type: string
description: Thirteenth customizable extension attribute.
nullable: true
extensionAttribute14:
type: string
description: Fourteenth customizable extension attribute.
nullable: true
extensionAttribute15:
type: string
description: Fifteenth customizable extension attribute.
nullable: true
extensionAttribute2:
type: string
description: Second customizable extension attribute.
nullable: true
extensionAttribute3:
type: string
description: Third customizable extension attribute.
nullable: true
extensionAttribute4:
type: string
description: Fourth customizable extension attribute.
nullable: true
extensionAttribute5:
type: string
description: Fifth customizable extension attribute.
nullable: true
extensionAttribute6:
type: string
description: Sixth customizable extension attribute.
nullable: true
extensionAttribute7:
type: string
description: Seventh customizable extension attribute.
nullable: true
extensionAttribute8:
type: string
description: Eighth customizable extension attribute.
nullable: true
extensionAttribute9:
type: string
description: Ninth customizable extension attribute.
nullable: true
additionalProperties:
type: object
microsoft.graph.onPremisesProvisioningError:
title: onPremisesProvisioningError
type: object
properties:
category:
type: string
description: 'Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.'
nullable: true
occurredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time at which the error occurred.
format: date-time
nullable: true
propertyCausingError:
type: string
description: 'Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress'
nullable: true
value:
type: string
description: Value of the property causing the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.passwordProfile:
title: passwordProfile
type: object
properties:
forceChangePasswordNextSignIn:
type: boolean
description: true if the user must change their password on the next sign-in; otherwise false.
nullable: true
forceChangePasswordNextSignInWithMfa:
type: boolean
description: 'If true, at next sign-in, the user must perform a multifactor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multifactor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.'
nullable: true
password:
type: string
description: 'The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next sign-in. The password must satisfy minimum requirements as specified by the user''s passwordPolicies property. By default, a strong password is required.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userPrint:
title: userPrint
type: object
properties:
recentPrinterShares:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printerShare'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.provisionedPlan:
title: provisionedPlan
type: object
properties:
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
provisioningStatus:
type: string
description: 'The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn''t provisioned and is in an error state.PendingInput - The service isn''t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn''t activated in the tenant.'
nullable: true
service:
type: string
description: 'The name of the service; for example, ''AccessControlS2S''.'
nullable: true
additionalProperties:
type: object
microsoft.graph.serviceProvisioningError:
title: serviceProvisioningError
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time at which the error occurred.
format: date-time
nullable: true
isResolved:
type: boolean
description: Indicates whether the error has been attended to.
nullable: true
serviceInstance:
type: string
description: 'Qualified service instance (for example, ''SharePoint/Dublin'') that published the service error information.'
nullable: true
additionalProperties:
type: object
microsoft.graph.signInActivity:
title: signInActivity
type: object
properties:
lastNonInteractiveSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted (either successfully or unsuccessfully) to sign in to the directory on behalf of a user. Because some users may use clients to access tenant resources rather than signing into your tenant directly, you can use the non-interactive sign-in date to along with lastSignInDateTime to identify inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains non-interactive sign-ins going back to May 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
format: date-time
nullable: true
lastNonInteractiveSignInRequestId:
type: string
description: Request identifier of the last non-interactive sign-in performed by this user.
nullable: true
lastSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The last interactive sign-in date and time for a specific user. This property records the last time a user attempted an interactive sign-in to the directory—whether the attempt was successful or not. Note: Since unsuccessful attempts are also logged, this value might not accurately reflect actual system usage. For tracking actual account access, please use the lastSuccessfulSignInDateTime property. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
lastSignInRequestId:
type: string
description: Request identifier of the last interactive sign-in performed by this user.
nullable: true
lastSuccessfulSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time of the user''s most recent successful interactive or non-interactive sign-in. Use this property if you need to determine when the account was truly accessed. This field can be used to build reports, such as inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains interactive sign-ins going back to April 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
format: date-time
nullable: true
lastSuccessfulSignInRequestId:
type: string
description: The request ID of the last successful sign-in.
nullable: true
additionalProperties:
type: object
microsoft.graph.userActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userActivity
type: object
properties:
activationUrl:
type: string
description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
activitySourceHost:
type: string
description: 'Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.'
appActivityId:
type: string
description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
appDisplayName:
type: string
description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
nullable: true
contentInfo:
$ref: '#/components/schemas/microsoft.graph.Json'
contentUrl:
type: string
description: 'Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object expired on the server.
format: date-time
nullable: true
fallbackUrl:
type: string
description: 'Optional. URL used to launch the activity in a web-based app, if available.'
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
nullable: true
visualElements:
$ref: '#/components/schemas/microsoft.graph.visualInfo'
historyItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
description: Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.adhocCall:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: adhocCall
type: object
properties:
recordings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
description: The recordings of a call. Read-only.
x-ms-navigationProperty: true
transcripts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
description: The transcripts of a call. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.appRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: appRoleAssignment
type: object
properties:
appRoleId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The identifier (id) for the app role that''s assigned to the principal. This app role must be exposed in the appRoles property on the resource application''s service principal (resourceId). If the resource application hasn''t declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.'
format: uuid
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
principalDisplayName:
type: string
description: 'The display name of the user, group, or service principal that was granted the app role assignment. Maximum length is 256 characters. Read-only. Supports $filter (eq and startswith).'
nullable: true
principalId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.'
format: uuid
nullable: true
principalType:
type: string
description: 'The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.'
nullable: true
resourceDisplayName:
type: string
description: The display name of the resource app's service principal to which the assignment is made. Maximum length is 256 characters.
nullable: true
resourceId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.authentication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authentication
type: object
properties:
emailMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
description: The email address registered to a user for authentication.
x-ms-navigationProperty: true
externalAuthenticationMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.externalAuthenticationMethod'
description: Represents the external MFA registered to a user for authentication using an external identity provider.
x-ms-navigationProperty: true
fido2Methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
description: Represents the FIDO2 security keys registered to a user for authentication.
x-ms-navigationProperty: true
methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
description: Represents all authentication methods registered to a user.
x-ms-navigationProperty: true
microsoftAuthenticatorMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
description: The details of the Microsoft Authenticator app registered to a user for authentication.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
description: 'Represents the status of a long-running operation, such as a password reset operation.'
x-ms-navigationProperty: true
passwordMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
description: 'Represents the password registered to a user for authentication. For security, the password itself is never returned in the object, but action can be taken to reset a password.'
x-ms-navigationProperty: true
phoneMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
description: The phone numbers registered to a user for authentication.
x-ms-navigationProperty: true
platformCredentialMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod'
description: Represents a platform credential instance registered to a user on Mac OS.
x-ms-navigationProperty: true
softwareOathMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
description: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
x-ms-navigationProperty: true
temporaryAccessPassMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
x-ms-navigationProperty: true
windowsHelloForBusinessMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
type: object
properties:
allowedOnlineMeetingProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
canEdit:
type: boolean
description: 'true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access.'
nullable: true
canShare:
type: boolean
description: 'true if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it.'
nullable: true
canViewPrivateItems:
type: boolean
description: 'If true, the user can read calendar items that have been marked private, false otherwise.'
nullable: true
changeKey:
type: string
description: 'Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
color:
$ref: '#/components/schemas/microsoft.graph.calendarColor'
defaultOnlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
hexColor:
type: string
description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.'
nullable: true
isDefaultCalendar:
type: boolean
description: 'true if this is the default calendar where new events are created by default, false otherwise.'
nullable: true
isRemovable:
type: boolean
description: Indicates whether this user calendar can be deleted from the user mailbox.
nullable: true
isTallyingResponses:
type: boolean
description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
nullable: true
name:
type: string
description: The calendar name.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
calendarPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
description: The permissions of the users with whom the calendar is shared.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The events in the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
type: object
properties:
changeKey:
type: string
description: 'Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
classId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The class identifier. Read-only.
format: uuid
nullable: true
name:
type: string
description: The group name.
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
type: object
properties:
allowNewTimeProposals:
type: boolean
description: 'true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true.'
nullable: true
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendee'
description: The collection of attendees for the event.
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The preview of the message associated with the event. It's in text format.
nullable: true
cancelledOccurrences:
type: array
items:
type: string
description: 'Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences.Requires $select to retrieve. Only returned in a Get operation that specifies the ID (seriesMasterId property value) of a series master event.'
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
hasAttachments:
type: boolean
description: Set to true if the event has attachments.
nullable: true
hideAttendees:
type: boolean
description: 'When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. The default is false.'
nullable: true
iCalUId:
type: string
description: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isAllDay:
type: boolean
description: 'Set to true if the event lasts all day. If true, regardless of whether it''s a single-day or multi-day event, start, and endtime must be set to midnight and be in the same time zone.'
nullable: true
isCancelled:
type: boolean
description: Set to true if the event has been canceled.
nullable: true
isDraft:
type: boolean
description: 'Set to true if the user has updated the meeting in Outlook but hasn''t sent the updates to attendees. Set to false if all changes are sent, or if the event is an appointment without any attendees.'
nullable: true
isOnlineMeeting:
type: boolean
description: 'True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.'
nullable: true
isOrganizer:
type: boolean
description: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). It also applies if a delegate organized the event on behalf of the owner.
nullable: true
isReminderOn:
type: boolean
description: Set to true if an alert is set to remind the user of the event.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.location'
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: 'The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection are removed and replaced by the new location value.'
onlineMeeting:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo'
onlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
onlineMeetingUrl:
type: string
description: 'A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.'
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.recipient'
originalEndTimeZone:
type: string
description: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
originalStart:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Represents the start time of an event when it''s initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
originalStartTimeZone:
type: string
description: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderMinutesBeforeStart:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of minutes before the event start time that the reminder alert occurs.
format: int32
nullable: true
responseRequested:
type: boolean
description: 'Default is true, which represents the organizer would like an invitee to send a response to the event.'
nullable: true
responseStatus:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
seriesMasterId:
type: string
description: 'The ID for the recurring series master item, if this event is part of a recurring series.'
nullable: true
showAs:
$ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
subject:
type: string
description: The text of the event's subject line.
nullable: true
transactionId:
type: string
description: 'A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. It''s useful when low network connectivity causes the client to time out before receiving a response from the server for the client''s prior create-event request. After you set transactionId when creating an event, you can''t change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.'
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.eventType'
webLink:
type: string
description: 'The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can''t be accessed from within an iFrame.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
exceptionOccurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'Contains the id property values of the event instances that are exceptions in a recurring series.Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don''t include canceled occurrences.Requires $select and $expand to retrieve. Only returned in a GET operation that specifies the ID (seriesMasterId property value) of a series master event.'
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the event. Nullable.
x-ms-navigationProperty: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.chat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chat
type: object
properties:
chatType:
$ref: '#/components/schemas/microsoft.graph.chatType'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time at which the chat was created. Read-only.
format: date-time
nullable: true
isHiddenForAllMembers:
type: boolean
description: Indicates whether the chat is hidden for all its members. Read-only.
nullable: true
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time at which the chat was renamed or the list of members was last changed. Read-only.
format: date-time
nullable: true
migrationMode:
$ref: '#/components/schemas/microsoft.graph.migrationMode'
onlineMeetingInfo:
$ref: '#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo'
originalCreatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp of the original creation time for the chat. The value is null if the chat never entered migration mode.
format: date-time
nullable: true
tenantId:
type: string
description: The identifier of the tenant in which the chat was created. Read-only.
nullable: true
topic:
type: string
description: (Optional) Subject or topic for the chat. Only available for group chats.
nullable: true
viewpoint:
$ref: '#/components/schemas/microsoft.graph.chatViewpoint'
webUrl:
type: string
description: 'The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: A collection of all the apps in the chat. Nullable.
x-ms-navigationProperty: true
lastMessagePreview:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of all the members in the chat. Nullable.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the chat. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: A collection of permissions granted to apps for the chat.
x-ms-navigationProperty: true
pinnedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
description: A collection of all the pinned messages in the chat. Nullable.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the chat. Nullable.
x-ms-navigationProperty: true
targetedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.targetedChatMessage'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.cloudClipboardRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardRoot
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
description: Represents a collection of Cloud Clipboard items.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.cloudPC:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudPC
type: object
properties:
aadDeviceId:
type: string
description: 'The Microsoft Entra device ID for the Cloud PC, also known as the Azure Active Directory (Azure AD) device ID, that consists of 32 characters in a GUID format. Generated on a VM joined to Microsoft Entra ID. Read-only.'
nullable: true
displayName:
type: string
description: 'The display name for the Cloud PC. Maximum length is 64 characters. Read-only. You can use the cloudPC: rename API to modify the Cloud PC name.'
nullable: true
gracePeriodEndDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the grace period ends and reprovisioning or deprovisioning happen. Required only if the status is inGracePeriod. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
imageDisplayName:
type: string
description: 'The name of the operating system image used for the Cloud PC. Maximum length is 50 characters. Only letters (A-Z, a-z), numbers (0-9), and special characters (-,,.) are allowed for this property. The property value can''t begin or end with an underscore. Read-only.'
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The last modified date and time of the Cloud PC. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
managedDeviceId:
type: string
description: The Intune enrolled device ID for the Cloud PC that consists of 32 characters in a GUID format. The managedDeviceId property of Windows 365 Business Cloud PCs is always null as Windows 365 Business Cloud PCs aren't Intune-enrolled automatically by Windows 365. Read-only.
nullable: true
managedDeviceName:
type: string
description: The Intune enrolled device name for the Cloud PC. The managedDeviceName property of Windows 365 Business Cloud PCs is always null as Windows 365 Business Cloud PCs aren't Intune-enrolled automatically by Windows 365. Read-only.
nullable: true
onPremisesConnectionName:
type: string
description: The on-premises connection that applied during the provisioning of Cloud PCs. Read-only.
nullable: true
provisioningPolicyId:
type: string
description: The provisioning policy ID for the Cloud PC that consists of 32 characters in a GUID format. A policy defines the type of Cloud PC the user wants to create. Read-only.
nullable: true
provisioningPolicyName:
type: string
description: The provisioning policy that applied during the provisioning of Cloud PCs. Maximum length is 120 characters. Read-only.
nullable: true
provisioningType:
$ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningType'
servicePlanId:
type: string
description: 'The service plan ID for the Cloud PC that consists of 32 characters in a GUID format. For more information about service plans, see Product names and service plan identifiers for licensing. Read-only.'
nullable: true
servicePlanName:
type: string
description: The service plan name for the customer-facing Cloud PC entity. Read-only.
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the user assigned to the Cloud PC. Maximum length is 113 characters. For more information on username policies, see Password policies and account restrictions in Microsoft Entra ID. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contactFolder
type: object
properties:
displayName:
type: string
description: The folder's display name.
nullable: true
parentFolderId:
type: string
description: The ID of the folder's parent folder.
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The collection of child folders in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The contacts in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.contact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: contact
type: object
properties:
assistantName:
type: string
description: The name of the contact's assistant.
nullable: true
birthday:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The contact''s birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
businessAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
businessHomePage:
type: string
description: The business home page of the contact.
nullable: true
businessPhones:
type: array
items:
type: string
nullable: true
description: The contact's business phone numbers.
children:
type: array
items:
type: string
nullable: true
description: The names of the contact's children.
companyName:
type: string
description: The name of the contact's company.
nullable: true
department:
type: string
description: The contact's department.
nullable: true
displayName:
type: string
description: 'The contact''s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.'
nullable: true
emailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
description: The contact's email addresses.
fileAs:
type: string
description: The name the contact is filed under.
nullable: true
generation:
type: string
description: The contact's suffix.
nullable: true
givenName:
type: string
description: The contact's given name.
nullable: true
homeAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
homePhones:
type: array
items:
type: string
nullable: true
description: The contact's home phone numbers.
imAddresses:
type: array
items:
type: string
nullable: true
description: The contact's instant messaging (IM) addresses.
initials:
type: string
description: The contact's initials.
nullable: true
jobTitle:
type: string
description: The contact’s job title.
nullable: true
manager:
type: string
description: The name of the contact's manager.
nullable: true
middleName:
type: string
description: The contact's middle name.
nullable: true
mobilePhone:
type: string
description: The contact's mobile phone number.
nullable: true
nickName:
type: string
description: The contact's nickname.
nullable: true
officeLocation:
type: string
description: The location of the contact's office.
nullable: true
otherAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
parentFolderId:
type: string
description: The ID of the contact's parent folder.
nullable: true
personalNotes:
type: string
description: The user's notes about the contact.
nullable: true
primaryEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
profession:
type: string
description: The contact's profession.
nullable: true
secondaryEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
spouseName:
type: string
description: The name of the contact's spouse/partner.
nullable: true
surname:
type: string
description: The contact's surname.
nullable: true
tertiaryEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
title:
type: string
description: The contact's title.
nullable: true
yomiCompanyName:
type: string
description: The phonetic Japanese company name of the contact.
nullable: true
yomiGivenName:
type: string
description: The phonetic Japanese given name (first name) of the contact.
nullable: true
yomiSurname:
type: string
description: The phonetic Japanese surname (last name) of the contact.
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userDataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.dataSecurityAndGovernance'
- title: userDataSecurityAndGovernance
type: object
properties:
activities:
$ref: '#/components/schemas/microsoft.graph.activitiesContainer'
protectionScopes:
$ref: '#/components/schemas/microsoft.graph.userProtectionScopeContainer'
additionalProperties:
type: object
microsoft.graph.deviceManagementTroubleshootingEvent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceManagementTroubleshootingEvent
type: object
properties:
correlationId:
type: string
description: Id used for tracing the failure in the service.
nullable: true
eventDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time when the event occurred .
format: date-time
additionalProperties:
type: object
description: Event representing an general failure.
microsoft.graph.drive:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: drive
type: object
properties:
driveType:
type: string
description: Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
quota:
$ref: '#/components/schemas/microsoft.graph.quota'
sharePointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
bundles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of bundles (albums and multi-select-shared sets of items). Only in personal OneDrive.
x-ms-navigationProperty: true
following:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: The list of items the user is following. Only in OneDrive for Business.
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: All items contained in the drive. Read-only. Nullable.
x-ms-navigationProperty: true
list:
$ref: '#/components/schemas/microsoft.graph.list'
root:
$ref: '#/components/schemas/microsoft.graph.driveItem'
special:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of common folders available in OneDrive. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.employeeExperienceUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: employeeExperienceUser
type: object
properties:
assignedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
description: Represents the collection of Viva Engage roles assigned to a user.
x-ms-navigationProperty: true
learningCourseActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
additionalProperties:
type: object
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: site
type: object
properties:
displayName:
type: string
description: The full title for the site. Read-only.
nullable: true
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
isPersonalSite:
type: boolean
description: Identifies whether the site is personal or not. Read-only.
nullable: true
root:
$ref: '#/components/schemas/microsoft.graph.root'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteCollection:
$ref: '#/components/schemas/microsoft.graph.siteCollection'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions reusable across lists under this site.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types defined for this site.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The collection of drives (document libraries) under this site.
x-ms-navigationProperty: true
externalColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseItem'
description: Used to address any item contained in this site. This collection can't be enumerated.
x-ms-navigationProperty: true
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.list'
description: The collection of lists under this site.
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the site.
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseSitePage'
description: The collection of pages in the baseSitePages list in this site.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The permissions associated with the site. Nullable.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The collection of the sub-sites under this site.
x-ms-navigationProperty: true
termStore:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
termStores:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
description: The collection of termStores under this site.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
type: object
properties:
overrides:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.itemInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
- title: itemInsights
type: object
additionalProperties:
type: object
microsoft.graph.team:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: team
type: object
properties:
classification:
type: string
description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a preconfigured set in the tenant's directory.
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp at which the team was created.
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the team. Maximum length: 1,024 characters.'
nullable: true
displayName:
type: string
description: The name of the team.
nullable: true
firstChannelName:
type: string
description: 'The name of the first channel in the team. This is an optional property, only used during team creation and isn''t returned in methods to get and list teams.'
nullable: true
funSettings:
$ref: '#/components/schemas/microsoft.graph.teamFunSettings'
guestSettings:
$ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
internalId:
type: string
description: A unique ID for the team that was used in a few places such as the audit log/Office 365 Management Activity API.
nullable: true
isArchived:
type: boolean
description: Whether this team is in read-only mode.
nullable: true
memberSettings:
$ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
messagingSettings:
$ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
specialization:
$ref: '#/components/schemas/microsoft.graph.teamSpecialization'
summary:
$ref: '#/components/schemas/microsoft.graph.teamSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
visibility:
$ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
webUrl:
type: string
description: 'A hyperlink that goes to the team in the Microsoft Teams client. You get this URL when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.'
nullable: true
allChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels either hosted in or shared with the team (incoming channels).
x-ms-navigationProperty: true
channels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: The collection of channels and messages associated with the team.
x-ms-navigationProperty: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
incomingChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels shared with the team.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: The apps installed in this team.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: Members and owners of the team.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
description: The async operations that ran or are running on this team.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: A collection of permissions granted to apps to access the team.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
primaryChannel:
$ref: '#/components/schemas/microsoft.graph.channel'
schedule:
$ref: '#/components/schemas/microsoft.graph.schedule'
tags:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
description: The tags associated with the team.
x-ms-navigationProperty: true
template:
$ref: '#/components/schemas/microsoft.graph.teamsTemplate'
additionalProperties:
type: object
microsoft.graph.licenseDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: licenseDetails
type: object
properties:
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
description: Information about the service plans assigned with the license. Read-only. Not nullable.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.
format: uuid
nullable: true
skuPartNumber:
type: string
description: 'Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
type: object
properties:
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of immediate child mailFolders in the current mailFolder.
format: int32
nullable: true
displayName:
type: string
description: The mailFolder's display name.
nullable: true
isHidden:
type: boolean
description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder.
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder marked as unread.
format: int32
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The collection of child folders in the mailFolder.
x-ms-navigationProperty: true
messageRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
description: The collection of rules that apply to the user's Inbox folder.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The collection of messages in the mailFolder.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.managedAppRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppRegistration
type: object
properties:
appIdentifier:
$ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
applicationVersion:
type: string
description: App version
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of creation
format: date-time
deviceName:
type: string
description: Host device name
nullable: true
deviceTag:
type: string
description: 'App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.'
nullable: true
deviceType:
type: string
description: Host device type
nullable: true
flaggedReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
lastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of last the app synced with management service.
format: date-time
managementSdkVersion:
type: string
description: App management SDK version
nullable: true
platformVersion:
type: string
description: Operating System version
nullable: true
userId:
type: string
description: The user Id to who this app registration belongs.
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
appliedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
x-ms-navigationProperty: true
intendedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policies admin intended for the app as of now.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppOperation'
description: Zero or more long running operations triggered on the app registration.
x-ms-navigationProperty: true
additionalProperties:
type: object
description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
microsoft.graph.managedDevice:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedDevice
type: object
properties:
activationLockBypassCode:
type: string
description: 'The code that allows the Activation Lock on managed device to be bypassed. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
androidSecurityPatchLevel:
type: string
description: Android security patch level. This property is read-only.
nullable: true
readOnly: true
azureADDeviceId:
type: string
description: The unique identifier for the Azure Active Directory device. Read only. This property is read-only.
nullable: true
readOnly: true
azureADRegistered:
type: boolean
description: Whether the device is Azure Active Directory registered. This property is read-only.
nullable: true
readOnly: true
complianceGracePeriodExpirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime when device compliance grace period expires. This property is read-only.
format: date-time
readOnly: true
complianceState:
$ref: '#/components/schemas/microsoft.graph.complianceState'
configurationManagerClientEnabledFeatures:
$ref: '#/components/schemas/microsoft.graph.configurationManagerClientEnabledFeatures'
deviceActionResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceActionResult'
description: List of ComplexType deviceActionResult objects. This property is read-only.
readOnly: true
deviceCategoryDisplayName:
type: string
description: Device category display name. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.
nullable: true
readOnly: true
deviceEnrollmentType:
$ref: '#/components/schemas/microsoft.graph.deviceEnrollmentType'
deviceHealthAttestationState:
$ref: '#/components/schemas/microsoft.graph.deviceHealthAttestationState'
deviceName:
type: string
description: Name of the device. This property is read-only.
nullable: true
readOnly: true
deviceRegistrationState:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationState'
easActivated:
type: boolean
description: Whether the device is Exchange ActiveSync activated. This property is read-only.
readOnly: true
easActivationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Exchange ActivationSync activation time of the device. This property is read-only.
format: date-time
readOnly: true
easDeviceId:
type: string
description: Exchange ActiveSync Id of the device. This property is read-only.
nullable: true
readOnly: true
emailAddress:
type: string
description: Email(s) for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
enrolledDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Enrollment time of the device. Supports $filter operator 'lt' and 'gt'. This property is read-only.
format: date-time
readOnly: true
enrollmentProfileName:
type: string
description: 'Name of the enrollment profile assigned to the device. Default value is empty string, indicating no enrollment profile was assgined. This property is read-only.'
nullable: true
readOnly: true
ethernetMacAddress:
type: string
description: 'Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
exchangeAccessState:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessState'
exchangeAccessStateReason:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessStateReason'
exchangeLastSuccessfulSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last time the device contacted Exchange. This property is read-only.
format: date-time
readOnly: true
freeStorageSpaceInBytes:
type: number
description: Free Storage in Bytes. Default value is 0. Read-only. This property is read-only.
format: int64
readOnly: true
iccid:
type: string
description: 'Integrated Circuit Card Identifier, it is A SIM card''s unique identification number. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
imei:
type: string
description: IMEI. This property is read-only.
nullable: true
readOnly: true
isEncrypted:
type: boolean
description: Device encryption status. This property is read-only.
readOnly: true
isSupervised:
type: boolean
description: Device supervised status. This property is read-only.
readOnly: true
jailBroken:
type: string
description: Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.
nullable: true
readOnly: true
lastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time that the device last completed a successful sync with Intune. Supports $filter operator 'lt' and 'gt'. This property is read-only.
format: date-time
readOnly: true
managedDeviceName:
type: string
description: Automatically generated name to identify a device. Can be overwritten to a user friendly name.
nullable: true
managedDeviceOwnerType:
$ref: '#/components/schemas/microsoft.graph.managedDeviceOwnerType'
managementAgent:
$ref: '#/components/schemas/microsoft.graph.managementAgentType'
managementCertificateExpirationDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Reports device management certificate expiration date. This property is read-only.
format: date-time
readOnly: true
managementState:
$ref: '#/components/schemas/microsoft.graph.managementState'
manufacturer:
type: string
description: Manufacturer of the device. This property is read-only.
nullable: true
readOnly: true
meid:
type: string
description: MEID. This property is read-only.
nullable: true
readOnly: true
model:
type: string
description: Model of the device. This property is read-only.
nullable: true
readOnly: true
notes:
type: string
description: 'Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.'
nullable: true
operatingSystem:
type: string
description: 'Operating system of the device. Windows, iOS, etc. This property is read-only.'
nullable: true
readOnly: true
osVersion:
type: string
description: Operating system version of the device. This property is read-only.
nullable: true
readOnly: true
partnerReportedThreatState:
$ref: '#/components/schemas/microsoft.graph.managedDevicePartnerReportedHealthState'
phoneNumber:
type: string
description: Phone number of the device. This property is read-only.
nullable: true
readOnly: true
physicalMemoryInBytes:
type: number
description: 'Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.'
format: int64
readOnly: true
remoteAssistanceSessionErrorDetails:
type: string
description: An error string that identifies issues when creating Remote Assistance session objects. This property is read-only.
nullable: true
readOnly: true
remoteAssistanceSessionUrl:
type: string
description: 'Url that allows a Remote Assistance session to be established with the device. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. This property is read-only.'
nullable: true
readOnly: true
requireUserEnrollmentApproval:
type: boolean
description: Reports if the managed iOS device is user approval enrollment. This property is read-only.
nullable: true
readOnly: true
serialNumber:
type: string
description: SerialNumber. This property is read-only.
nullable: true
readOnly: true
subscriberCarrier:
type: string
description: Subscriber Carrier. This property is read-only.
nullable: true
readOnly: true
totalStorageSpaceInBytes:
type: number
description: Total Storage in Bytes. This property is read-only.
format: int64
readOnly: true
udid:
type: string
description: 'Unique Device Identifier for iOS and macOS devices. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
userDisplayName:
type: string
description: User display name. This property is read-only.
nullable: true
readOnly: true
userId:
type: string
description: Unique Identifier for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
userPrincipalName:
type: string
description: Device user principal name. This property is read-only.
nullable: true
readOnly: true
wiFiMacAddress:
type: string
description: Wi-Fi MAC. This property is read-only.
nullable: true
readOnly: true
deviceCategory:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
deviceCompliancePolicyStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
description: Device compliance policy states for this device.
x-ms-navigationProperty: true
deviceConfigurationStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
description: Device configuration states for this device.
x-ms-navigationProperty: true
logCollectionRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
description: List of log collection requests
x-ms-navigationProperty: true
users:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The primary users associated with the managed device.
x-ms-navigationProperty: true
windowsProtectionState:
$ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
additionalProperties:
type: object
description: 'Devices that are managed or pre-enrolled through Intune. Limited support for $filter: Only properties whose descriptions mention support for $filter may be used, and combinations of those filtered properties must use ''and'', not ''or''.'
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
type: object
properties:
bccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Bcc: recipients for the message.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The first 255 characters of the message body. It is in text format.
nullable: true
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the message.'
conversationId:
type: string
description: The ID of the conversation the email belongs to.
nullable: true
conversationIndex:
type: string
description: Indicates the position of the message within the conversation.
format: base64url
nullable: true
flag:
$ref: '#/components/schemas/microsoft.graph.followupFlag'
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as
.'
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
internetMessageHeaders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Requires $select to retrieve. Read-only.
internetMessageId:
type: string
description: The message ID in the format specified by RFC2822.
nullable: true
isDeliveryReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
isDraft:
type: boolean
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
nullable: true
isRead:
type: boolean
description: Indicates whether the message has been read.
nullable: true
isReadReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the message's parent mailFolder.
nullable: true
receivedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
replyTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to use when replying.
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
sentDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
subject:
type: string
description: The subject of the message.
nullable: true
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the message.'
uniqueBody:
$ref: '#/components/schemas/microsoft.graph.itemBody'
webLink:
type: string
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.NOTE: When using this URL to access a message from a mailbox with delegate permissions, both the signed-in user and the target mailbox must be in the same database region. For example, an error is returned when a user with a mailbox in the EUR (Europe) region attempts to access messages from a mailbox in the NAM (North America) region.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: The fileAttachment and itemAttachment attachments for the message.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the message. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.oAuth2PermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: oAuth2PermissionGrant
type: object
properties:
clientId:
type: string
description: The object id (not appId) of the client service principal for the application that's authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
consentType:
type: string
description: 'Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users might be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).'
nullable: true
principalId:
type: string
description: 'The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only).'
nullable: true
resourceId:
type: string
description: The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).
scope:
type: string
description: 'A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3,850 characters in length.'
nullable: true
additionalProperties:
type: object
microsoft.graph.onenote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenote
type: object
properties:
notebooks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.notebook'
description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
description: 'The status of OneNote operations. Getting an operations collection isn''t supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.'
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
description: 'The image and other file resources in OneNote pages. Getting a resources collection isn''t supported, but you can get the binary content of a specific resource. Read-only. Nullable.'
x-ms-navigationProperty: true
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onlineMeeting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingBase'
- title: onlineMeeting
type: object
properties:
attendeeReport:
type: string
description: The content stream of the attendee report of a Microsoft Teams live event. Read-only.
format: base64url
nullable: true
broadcastSettings:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingSettings'
creationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The meeting creation time in UTC. Read-only.
format: date-time
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The meeting end time in UTC. Required when you create an online meeting.
format: date-time
nullable: true
externalId:
type: string
description: The external ID that is a custom identifier. Optional.
nullable: true
isBroadcast:
type: boolean
description: Indicates whether this meeting is a Teams live event.
nullable: true
meetingTemplateId:
type: string
description: The ID of the meeting template.
nullable: true
participants:
$ref: '#/components/schemas/microsoft.graph.meetingParticipants'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The meeting start time in UTC.
format: date-time
nullable: true
recordings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
description: The recordings of an online meeting. Read-only.
x-ms-navigationProperty: true
transcripts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
description: The transcripts of an online meeting. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onPremisesSyncBehavior:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onPremisesSyncBehavior
type: object
properties:
isCloudManaged:
type: boolean
additionalProperties:
type: object
microsoft.graph.outlookUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookUser
type: object
properties:
masterCategories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
description: A list of categories defined for the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.person:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: person
type: object
properties:
birthday:
type: string
description: The person's birthday.
nullable: true
companyName:
type: string
description: The name of the person's company.
nullable: true
department:
type: string
description: The person's department.
nullable: true
displayName:
type: string
description: The person's display name.
nullable: true
givenName:
type: string
description: The person's given name.
nullable: true
imAddress:
type: string
description: The instant message voice over IP (VOIP) session initiation protocol (SIP) address for the user. Read-only.
nullable: true
isFavorite:
type: boolean
description: True if the user has flagged this person as a favorite.
nullable: true
jobTitle:
type: string
description: The person's job title.
nullable: true
officeLocation:
type: string
description: The location of the person's office.
nullable: true
personNotes:
type: string
description: Free-form notes that the user has taken about this person.
nullable: true
personType:
$ref: '#/components/schemas/microsoft.graph.personType'
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: The person's phone numbers.
postalAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: The person's addresses.
profession:
type: string
description: The person's profession.
nullable: true
scoredEmailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scoredEmailAddress'
description: The person's email addresses.
surname:
type: string
description: The person's surname.
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person''s email name. The general format is alias@domain.'
nullable: true
websites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.website'
description: The person's websites.
yomiCompany:
type: string
description: The phonetic Japanese name of the person's company.
nullable: true
additionalProperties:
type: object
microsoft.graph.resourceSpecificPermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: resourceSpecificPermissionGrant
type: object
properties:
clientAppId:
type: string
description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
nullable: true
clientId:
type: string
description: ID of the Microsoft Entra app that has been granted access. Read-only.
nullable: true
permission:
type: string
description: The name of the resource-specific permission. Read-only.
nullable: true
permissionType:
type: string
description: 'The type of permission. The possible values are: Application, Delegated. Read-only.'
nullable: true
resourceAppId:
type: string
description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: The height of the photo. Read-only.
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: The width of the photo. Read-only.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerUser
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Returns the plannerPlans shared with the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.presence:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: presence
type: object
properties:
activity:
type: string
description: 'The supplemental information to a user''s availability. Possible values are available, away, beRightBack, busy, doNotDisturb, offline, outOfOffice, presenceUnknown.'
nullable: true
availability:
type: string
description: 'The base presence information for a user. Possible values are available, away, beRightBack, busy, doNotDisturb, focusing, inACall, inAMeeting, offline, presenting, presenceUnknown.'
nullable: true
outOfOfficeSettings:
$ref: '#/components/schemas/microsoft.graph.outOfOfficeSettings'
sequenceNumber:
type: string
description: The lexicographically sortable String stamp that represents the version of a presence object.
nullable: true
readOnly: true
statusMessage:
$ref: '#/components/schemas/microsoft.graph.presenceStatusMessage'
workLocation:
$ref: '#/components/schemas/microsoft.graph.userWorkLocation'
additionalProperties:
type: object
microsoft.graph.scopedRoleMembership:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: scopedRoleMembership
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'
additionalProperties:
type: object
microsoft.graph.userSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSettings
type: object
properties:
contributionToContentDiscoveryAsOrganizationDisabled:
type: boolean
description: 'Reflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn''t have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center.'
contributionToContentDiscoveryDisabled:
type: boolean
description: 'When set to true, the delegate access to the user''s trending API is disabled. When set to true, documents in the user''s Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve.'
exchange:
$ref: '#/components/schemas/microsoft.graph.exchangeSettings'
itemInsights:
$ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
shiftPreferences:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
storage:
$ref: '#/components/schemas/microsoft.graph.userStorage'
windows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
description: The Windows settings of the user stored in the cloud.
x-ms-navigationProperty: true
workHoursAndLocations:
$ref: '#/components/schemas/microsoft.graph.workHoursAndLocationsSetting'
additionalProperties:
type: object
microsoft.graph.userSolutionRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSolutionRoot
type: object
properties:
workingTimeSchedule:
$ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
additionalProperties:
type: object
microsoft.graph.userTeamwork:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userTeamwork
type: object
properties:
locale:
type: string
description: 'Represents the location that a user selected in Microsoft Teams and doesn''t follow the Office''s locale setting. A user''s locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
region:
type: string
description: 'Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user''s region (if available). For users without multigeo licenses, the property contains the organization''s region.The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.'
nullable: true
associatedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
description: The list of associatedTeamInfo objects that a user is associated with.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
description: The apps installed in the personal scope of this user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.todo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todo
type: object
properties:
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
description: The task lists in the users mailbox.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.automaticRepliesSetting:
title: automaticRepliesSetting
type: object
properties:
externalAudience:
$ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
externalReplyMessage:
type: string
description: 'The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.'
nullable: true
internalReplyMessage:
type: string
description: 'The automatic reply to send to the audience internal to the signed-in user''s organization, if Status is AlwaysEnabled or Scheduled.'
nullable: true
scheduledEndDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
scheduledStartDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
status:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
additionalProperties:
type: object
microsoft.graph.delegateMeetingMessageDeliveryOptions:
title: delegateMeetingMessageDeliveryOptions
enum:
- sendToDelegateAndInformationToPrincipal
- sendToDelegateAndPrincipal
- sendToDelegateOnly
type: string
microsoft.graph.localeInfo:
title: localeInfo
type: object
properties:
displayName:
type: string
description: 'A name representing the user''s locale in natural language, for example, ''English (United States)''.'
nullable: true
locale:
type: string
description: 'A locale representation for the user, which includes the user''s preferred language and country/region. For example, ''en-us''. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userPurpose:
title: userPurpose
enum:
- user
- linked
- shared
- room
- equipment
- others
- unknownFutureValue
type: string
microsoft.graph.workingHours:
title: workingHours
type: object
properties:
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: The days of the week on which the user works.
endTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user stops working.
format: time
nullable: true
startTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user starts working.
format: time
nullable: true
timeZone:
$ref: '#/components/schemas/microsoft.graph.timeZoneBase'
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowBase:
title: workflowBase
type: object
properties:
category:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowCategory'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When a workflow was created.
format: date-time
nullable: true
description:
type: string
description: A string that describes the purpose of the workflow.
nullable: true
displayName:
type: string
description: A string to identify the workflow.
executionConditions:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowExecutionConditions'
isEnabled:
type: boolean
description: 'Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true.'
isSchedulingEnabled:
type: boolean
description: 'If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can''t be true for a disabled workflow (where isEnabled is false).'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the workflow was last modified.
format: date-time
nullable: true
administrationScopeTargets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The administrative units in the scope of the workflow. Optional. Supports $expand.
x-ms-navigationProperty: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.user'
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.user'
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
description: The tasks in the workflow.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.quarantineDetails:
title: quarantineDetails
type: object
properties:
quarantinedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the workflow was quarantined.
format: date-time
nullable: true
quarantineReason:
type: string
description: The reason the workflow was quarantined.
nullable: true
quarantineType:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineType'
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowSetting:
title: workflowSetting
type: object
properties:
quarantineConfiguration:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration'
additionalProperties:
type: object
microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus:
title: lifecycleWorkflowProcessingStatus
enum:
- queued
- inProgress
- completed
- completedWithErrors
- canceled
- failed
- unknownFutureValue
- canceling
- quarantined
type: string
microsoft.graph.identityGovernance.workflowExecutionType:
title: workflowExecutionType
enum:
- scheduled
- onDemand
- unknownFutureValue
- activatedWithScope
- preview
type: string
microsoft.graph.identityGovernance.customTaskExtensionOperationStatus:
title: customTaskExtensionOperationStatus
enum:
- completed
- failed
- unknownFutureValue
type: string
microsoft.graph.keyValuePair:
title: keyValuePair
type: object
properties:
name:
type: string
description: Name for this key-value pair
value:
type: string
description: Value for this key-value pair
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.lifecycleTaskCategory:
title: lifecycleTaskCategory
enum:
- joiner
- leaver
- unknownFutureValue
- mover
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.identityGovernance.parameter:
title: parameter
type: object
properties:
name:
type: string
description: The name of the parameter.
values:
type: array
items:
type: string
nullable: true
description: The values of the parameter.
valueType:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.valueType'
additionalProperties:
type: object
microsoft.graph.identityGovernance.lifecycleWorkflowCategory:
title: lifecycleWorkflowCategory
enum:
- joiner
- leaver
- unknownFutureValue
- mover
type: string
microsoft.graph.emailSettings:
title: emailSettings
type: object
properties:
senderDomain:
type: string
description: 'Specifies the domain that should be used when sending email notifications. This domain must be verified in order to be used. We recommend that you use a domain that has the appropriate DNS records to facilitate email validation, like SPF, DKIM, DMARC, and MX, because this then complies with the RFC compliance for sending and receiving email. For details, see Learn more about Exchange Online Email Routing.'
useCompanyBranding:
type: boolean
description: Specifies if the organization’s banner logo should be included in email notifications. The banner logo will replace the Microsoft logo at the top of the email notification. If true the banner logo will be taken from the tenant’s branding settings. This value can only be set to true if the organizationalBranding bannerLogo property is set.
additionalProperties:
type: object
microsoft.graph.identityGovernance.quarantineConfiguration:
title: quarantineConfiguration
type: object
properties:
conditions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineCondition'
description: The set of threshold conditions evaluated for the workflow. Each condition is either a countBasedQuarantineCondition or a percentageBasedQuarantineCondition.
matchMode:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.matchMode'
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowExecutionConditions:
title: workflowExecutionConditions
type: object
additionalProperties:
type: object
microsoft.graph.privilegedAccessScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: privilegedAccessScheduleInstance
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule instance ends. Required.
format: date-time
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When this instance starts. Required.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupRelationships:
title: privilegedAccessGroupRelationships
enum:
- owner
- member
- unknownFutureValue
type: string
microsoft.graph.privilegedAccessGroupAssignmentType:
title: privilegedAccessGroupAssignmentType
enum:
- assigned
- activated
- unknownFutureValue
type: string
microsoft.graph.privilegedAccessGroupMemberType:
title: privilegedAccessGroupMemberType
enum:
- direct
- group
- unknownFutureValue
type: string
microsoft.graph.groupAccessType:
title: groupAccessType
enum:
- none
- private
- secret
- public
- unknownFutureValue
type: string
microsoft.graph.assignedLabel:
title: assignedLabel
type: object
properties:
displayName:
type: string
description: The display name of the label. Read-only.
nullable: true
labelId:
type: string
description: The unique identifier of the label.
nullable: true
additionalProperties:
type: object
microsoft.graph.licenseProcessingState:
title: licenseProcessingState
type: object
properties:
state:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.conversation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversation
type: object
properties:
hasAttachments:
type: boolean
description: 'Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.'
lastDeliveredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
preview:
type: string
description: 'A short summary from the body of the latest post in this conversation. Supports $filter (eq, ne, le, ge).'
topic:
type: string
description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.'
uniqueSenders:
type: array
items:
type: string
description: All the users that sent a message to this Conversation.
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.groupLifecyclePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupLifecyclePolicy
type: object
properties:
alternateNotificationEmails:
type: string
description: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
nullable: true
groupLifetimeInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.'
format: int32
nullable: true
managedGroupTypes:
type: string
description: 'The group type for which the expiration policy applies. Possible values are All, Selected or None.'
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerGroup
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerPlans owned by the group.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.groupSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupSetting
type: object
properties:
displayName:
type: string
description: 'Display name of this group of settings, which comes from the associated template.'
nullable: true
templateId:
type: string
description: Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
nullable: true
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingValue'
description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.
additionalProperties:
type: object
microsoft.graph.conversationThread:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationThread
type: object
properties:
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the thread. Requires $select to retrieve.'
hasAttachments:
type: boolean
description: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.
isLocked:
type: boolean
description: Indicates if the thread is locked. Returned by default.
lastDeliveredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.Returned by default.'
format: date-time
preview:
type: string
description: A short summary from the body of the latest post in this conversation. Returned by default.
topic:
type: string
description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.'
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the thread. Requires $select to retrieve.'
uniqueSenders:
type: array
items:
type: string
description: All the users that sent a message to this thread. Returned by default.
posts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.post'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: privilegedAccessScheduleRequest
type: object
properties:
action:
$ref: '#/components/schemas/microsoft.graph.scheduleRequestActions'
isValidationOnly:
type: boolean
description: Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
nullable: true
justification:
type: string
description: A message provided by users and administrators when create they create the privilegedAccessGroupAssignmentScheduleRequest object.
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
ticketInfo:
$ref: '#/components/schemas/microsoft.graph.ticketInfo'
additionalProperties:
type: object
microsoft.graph.privilegedAccessSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: privilegedAccessSchedule
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule was created. Optional.
format: date-time
nullable: true
createdUsing:
type: string
description: The identifier of the access assignment or eligibility request that created this schedule. Optional.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule was last modified. Optional.
format: date-time
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
status:
type: string
description: 'The status of the access assignment or eligibility request. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable. Optional.'
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRolePermission:
title: unifiedRolePermission
type: object
properties:
allowedResourceActions:
type: array
items:
type: string
description: Set of tasks that can be performed on a resource. Required.
condition:
type: string
description: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.
nullable: true
excludedResourceActions:
type: array
items:
type: string
nullable: true
description: Set of tasks that may not be performed on a resource. Not yet supported.
additionalProperties:
type: object
microsoft.graph.unifiedRoleScheduleInstanceBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleScheduleInstanceBase
type: object
properties:
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.'
nullable: true
directoryScopeId:
type: string
description: Identifier of the directory object representing the scope of the assignment or role eligibility. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.
nullable: true
principalId:
type: string
description: Identifier of the principal that has been granted the role assignment or that's eligible for a role.
nullable: true
roleDefinitionId:
type: string
description: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that the principal is eligible for.
nullable: true
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
additionalProperties:
type: object
microsoft.graph.unifiedRoleScheduleRequestActions:
title: unifiedRoleScheduleRequestActions
enum:
- adminAssign
- adminUpdate
- adminRemove
- selfActivate
- selfDeactivate
- adminExtend
- adminRenew
- selfExtend
- selfRenew
- unknownFutureValue
type: string
microsoft.graph.requestSchedule:
title: requestSchedule
type: object
properties:
expiration:
$ref: '#/components/schemas/microsoft.graph.expirationPattern'
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the eligible or active assignment becomes active.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.ticketInfo:
title: ticketInfo
type: object
properties:
ticketNumber:
type: string
description: The ticket number.
nullable: true
ticketSystem:
type: string
description: The description of the ticket system.
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleScheduleBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleScheduleBase
type: object
properties:
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment or eligibility is scoped to an app. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule was created.
format: date-time
nullable: true
createdUsing:
type: string
description: Identifier of the object through which this schedule was created.
nullable: true
directoryScopeId:
type: string
description: Identifier of the directory object representing the scope of the assignment or eligibility. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule was last modified.
format: date-time
nullable: true
principalId:
type: string
description: Identifier of the principal that has been granted the role assignment or eligibility.
nullable: true
roleDefinitionId:
type: string
description: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that a principal is eligible for.
nullable: true
status:
type: string
description: The status of the role assignment or eligibility request.
nullable: true
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
additionalProperties:
type: object
ReferenceCreate:
type: object
properties:
'@odata.id':
type: string
additionalProperties:
type: object
microsoft.graph.agreementCollectionResponse:
title: Collection of agreement
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreement'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.ODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
additionalProperties:
type: object
microsoft.graph.agreementAcceptanceCollectionResponse:
title: Collection of agreementAcceptance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
ODataCountResponse:
type: integer
format: int32
microsoft.graph.agreementFileLocalizationCollectionResponse:
title: Collection of agreementFileLocalization
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementFileVersionCollectionResponse:
title: Collection of agreementFileVersion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewScheduleDefinitionCollectionResponse:
title: Collection of accessReviewScheduleDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceCollectionResponse:
title: Collection of accessReviewInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewReviewerCollectionResponse:
title: Collection of accessReviewReviewer
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItemCollectionResponse:
title: Collection of accessReviewInstanceDecisionItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.governanceInsightCollectionResponse:
title: Collection of governanceInsight
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.governanceInsight'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewStageCollectionResponse:
title: Collection of accessReviewStage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryDefinitionCollectionResponse:
title: Collection of accessReviewHistoryDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryInstanceCollectionResponse:
title: Collection of accessReviewHistoryInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.appConsentRequestCollectionResponse:
title: Collection of appConsentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.userConsentRequestCollectionResponse:
title: Collection of userConsentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.approvalStageCollectionResponse:
title: Collection of approvalStage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageCatalogCollectionResponse:
title: Collection of accessPackageCatalog
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageCollectionResponse:
title: Collection of accessPackage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.customCalloutExtensionCollectionResponse:
title: Collection of customCalloutExtension
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceRoleCollectionResponse:
title: Collection of accessPackageResourceRole
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRole'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceScopeCollectionResponse:
title: Collection of accessPackageResourceScope
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceScope'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourceUploadSessionCollectionResponse:
title: Collection of customDataProvidedResourceUploadSession
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceUploadSession'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.customDataProvidedResourceFileCollectionResponse:
title: Collection of customDataProvidedResourceFile
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customDataProvidedResourceFile'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceCollectionResponse:
title: Collection of accessPackageResource
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResource'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.approvalCollectionResponse:
title: Collection of approval
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentPolicyCollectionResponse:
title: Collection of accessPackageAssignmentPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.customExtensionStageSettingCollectionResponse:
title: Collection of customExtensionStageSetting
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customExtensionStageSetting'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageQuestionCollectionResponse:
title: Collection of accessPackageQuestion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
StringCollectionResponse:
title: Collection of string
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.groupCollectionResponse:
title: Collection of group
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.serviceProvisioningErrorCollectionResponse:
title: Collection of microsoft.graph.serviceProvisioningError
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceRoleScopeCollectionResponse:
title: Collection of accessPackageResourceRoleScope
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRoleScope'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageSuggestionCollectionResponse:
title: Collection of accessPackageSuggestion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageSuggestion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestCollectionResponse:
title: Collection of accessPackageAssignmentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentCollectionResponse:
title: Collection of accessPackageAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.availableAccessPackageCollectionResponse:
title: Collection of availableAccessPackage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.availableAccessPackage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.connectedOrganizationCollectionResponse:
title: Collection of connectedOrganization
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.directoryObjectCollectionResponse:
title: Collection of directoryObject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.controlConfigurationCollectionResponse:
title: Collection of controlConfiguration
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.controlConfiguration'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceEnvironmentCollectionResponse:
title: Collection of accessPackageResourceEnvironment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceEnvironment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageResourceRequestCollectionResponse:
title: Collection of accessPackageResourceRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageResourceRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageSubjectCollectionResponse:
title: Collection of accessPackageSubject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.customTaskExtensionCollectionResponse:
title: Collection of customTaskExtension
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.customTaskExtension'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowCollectionResponse:
title: Collection of workflow
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflow'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.userProcessingResultCollectionResponse:
title: Collection of userProcessingResult
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.userProcessingResult'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.runCollectionResponse:
title: Collection of run
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.run'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskProcessingResultCollectionResponse:
title: Collection of taskProcessingResult
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskProcessingResult'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskReportCollectionResponse:
title: Collection of taskReport
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskReport'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskCollectionResponse:
title: Collection of task
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.task'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowVersionCollectionResponse:
title: Collection of workflowVersion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowVersion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.taskDefinitionCollectionResponse:
title: Collection of taskDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.taskDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.workflowTemplateCollectionResponse:
title: Collection of workflowTemplate
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityGovernance.workflowTemplate'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupAssignmentScheduleInstanceCollectionResponse:
title: Collection of privilegedAccessGroupAssignmentScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupAssignmentScheduleRequestCollectionResponse:
title: Collection of privilegedAccessGroupAssignmentScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupAssignmentScheduleCollectionResponse:
title: Collection of privilegedAccessGroupAssignmentSchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupAssignmentSchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupEligibilityScheduleInstanceCollectionResponse:
title: Collection of privilegedAccessGroupEligibilityScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupEligibilityScheduleRequestCollectionResponse:
title: Collection of privilegedAccessGroupEligibilityScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilityScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.privilegedAccessGroupEligibilityScheduleCollectionResponse:
title: Collection of privilegedAccessGroupEligibilitySchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.privilegedAccessGroupEligibilitySchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceNamespaceCollectionResponse:
title: Collection of unifiedRbacResourceNamespace
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceActionCollectionResponse:
title: Collection of unifiedRbacResourceAction
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentCollectionResponse:
title: Collection of unifiedRoleAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleInstanceCollectionResponse:
title: Collection of unifiedRoleAssignmentScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleRequestCollectionResponse:
title: Collection of unifiedRoleAssignmentScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleCollectionResponse:
title: Collection of unifiedRoleAssignmentSchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleDefinitionCollectionResponse:
title: Collection of unifiedRoleDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleInstanceCollectionResponse:
title: Collection of unifiedRoleEligibilityScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleRequestCollectionResponse:
title: Collection of unifiedRoleEligibilityScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleCollectionResponse:
title: Collection of unifiedRoleEligibilitySchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementFileData:
title: agreementFileData
type: object
properties:
data:
type: string
description: Data that represents the terms of use PDF document. Read-only.
format: base64url
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewNotificationRecipientScope:
title: accessReviewNotificationRecipientScope
type: object
additionalProperties:
type: object
microsoft.graph.accessReviewApplyAction:
title: accessReviewApplyAction
type: object
additionalProperties:
type: object
microsoft.graph.accessReviewRecommendationInsightSetting:
title: accessReviewRecommendationInsightSetting
type: object
additionalProperties:
type: object
microsoft.graph.patternedRecurrence:
title: patternedRecurrence
type: object
properties:
pattern:
$ref: '#/components/schemas/microsoft.graph.recurrencePattern'
range:
$ref: '#/components/schemas/microsoft.graph.recurrenceRange'
additionalProperties:
type: object
microsoft.graph.identitySet:
title: identitySet
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
device:
$ref: '#/components/schemas/microsoft.graph.identity'
user:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.accessPackageResourceAttributeDestination:
title: accessPackageResourceAttributeDestination
type: object
additionalProperties:
type: object
microsoft.graph.accessPackageResourceAttributeSource:
title: accessPackageResourceAttributeSource
type: object
additionalProperties:
type: object
microsoft.graph.expirationPatternType:
title: expirationPatternType
enum:
- notSpecified
- noExpiration
- afterDateTime
- afterDuration
type: string
microsoft.graph.accessPackageApprovalStage:
title: accessPackageApprovalStage
type: object
properties:
approverInformationVisibility:
$ref: '#/components/schemas/microsoft.graph.approverInformationVisibility'
durationBeforeAutomaticDenial:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: The number of days that a request can be pending a response before it is automatically denied.
format: duration
nullable: true
durationBeforeEscalation:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'If escalation is required, the time a request can be pending a response from a primary approver.'
format: duration
nullable: true
escalationApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'If escalation is enabled and the primary approvers do not respond before the escalation time, the escalationApprovers are the users who are asked to approve requests.'
fallbackEscalationApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'The subjects, typically users, who are the fallback escalation approvers.'
fallbackPrimaryApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'The subjects, typically users, who are the fallback primary approvers.'
isApproverJustificationRequired:
type: boolean
description: Indicates whether the approver is required to provide a justification for approving a request.
nullable: true
isEscalationEnabled:
type: boolean
description: 'If true, then one or more escalationApprovers are configured in this approval stage.'
nullable: true
primaryApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'The subjects, typically users, who are asked to approve requests. A collection of singleUser, groupMembers, requestorManager, internalSponsors, externalSponsors, or targetUserSponsors.'
additionalProperties:
type: object
microsoft.graph.accessReviewExpirationBehavior:
title: accessReviewExpirationBehavior
enum:
- keepAccess
- removeAccess
- acceptAccessRecommendation
- unknownFutureValue
type: string
microsoft.graph.customExtensionCalloutInstanceStatus:
title: customExtensionCalloutInstanceStatus
enum:
- calloutSent
- callbackReceived
- calloutFailed
- callbackTimedOut
- waitingForCallback
- unknownFutureValue
type: string
microsoft.graph.printerShare:
allOf:
- $ref: '#/components/schemas/microsoft.graph.printerBase'
- title: printerShare
type: object
properties:
allowAllUsers:
type: boolean
description: 'If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties.'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTimeOffset when the printer share was created. Read-only.
format: date-time
viewPoint:
$ref: '#/components/schemas/microsoft.graph.printerShareViewpoint'
allowedGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
description: The groups whose users have access to print using the printer.
x-ms-navigationProperty: true
allowedUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The users who have access to print using the printer.
x-ms-navigationProperty: true
printer:
$ref: '#/components/schemas/microsoft.graph.printer'
additionalProperties:
type: object
microsoft.graph.Json:
title: Json
type: object
additionalProperties:
type: object
description: Standard way to represent a Json blob on Graph.
microsoft.graph.status:
title: status
enum:
- active
- updated
- deleted
- ignored
- unknownFutureValue
type: string
microsoft.graph.visualInfo:
title: visualInfo
type: object
properties:
attribution:
$ref: '#/components/schemas/microsoft.graph.imageInfo'
backgroundColor:
type: string
description: Optional. Background color used to render the activity in the UI - brand color for the application source of the activity. Must be a valid hex color
nullable: true
content:
$ref: '#/components/schemas/microsoft.graph.Json'
description:
type: string
description: 'Optional. Longer text description of the user''s unique activity (example: document name, first sentence, and/or metadata)'
nullable: true
displayText:
type: string
description: 'Required. Short text description of the user''s unique activity (for example, document name in cases where an activity refers to document creation)'
additionalProperties:
type: object
microsoft.graph.activityHistoryItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activityHistoryItem
type: object
properties:
activeDurationSeconds:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.'
format: int32
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.
format: date-time
nullable: true
lastActiveDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
startedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.
format: date-time
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time. Values supplied as Olson IDs in order to support cross-platform representation.
nullable: true
activity:
$ref: '#/components/schemas/microsoft.graph.userActivity'
additionalProperties:
type: object
microsoft.graph.callRecording:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: callRecording
type: object
properties:
callId:
type: string
description: The unique identifier for the call that is related to this recording. Read-only.
nullable: true
content:
type: string
description: The content of the recording. Read-only.
format: base64url
nullable: true
contentCorrelationId:
type: string
description: The unique identifier that links the transcript with its corresponding recording. Read-only.
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time at which the recording was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time at which the recording ends. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
meetingId:
type: string
description: The unique identifier of the onlineMeeting related to this recording. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/microsoft.graph.identitySet'
recordingContentUrl:
type: string
description: The URL that can be used to access the content of the recording. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.callTranscript:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: callTranscript
type: object
properties:
callId:
type: string
description: The unique identifier for the call that is related to this transcript. Read-only.
nullable: true
content:
type: string
description: The content of the transcript. Read-only.
format: base64url
nullable: true
contentCorrelationId:
type: string
description: The unique identifier that links the transcript with its corresponding recording. Read-only.
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time at which the transcript was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time at which the transcription ends. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
meetingId:
type: string
description: The unique identifier of the online meeting related to this transcript. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/microsoft.graph.identitySet'
metadataContent:
type: string
description: The time-aligned metadata of the utterances in the transcript. Read-only.
format: base64url
nullable: true
transcriptContentUrl:
type: string
description: The URL that can be used to access the content of the transcript. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.emailAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: emailAuthenticationMethod
type: object
properties:
emailAddress:
type: string
description: The email address registered to this user.
nullable: true
additionalProperties:
type: object
microsoft.graph.externalAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: externalAuthenticationMethod
type: object
properties:
configurationId:
type: string
description: A unique identifier used to manage the external auth method within Microsoft Entra ID.
displayName:
type: string
description: Custom name given to the registered external MFA.
additionalProperties:
type: object
microsoft.graph.fido2AuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: fido2AuthenticationMethod
type: object
properties:
aaGuid:
type: string
description: 'Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.'
nullable: true
attestationCertificates:
type: array
items:
type: string
nullable: true
description: The attestation certificate or certificates attached to this passkey.
attestationLevel:
$ref: '#/components/schemas/microsoft.graph.attestationLevel'
displayName:
type: string
description: The display name of the key as given by the user.
nullable: true
model:
type: string
description: The manufacturer-assigned model of the FIDO2 passkey.
nullable: true
passkeyType:
$ref: '#/components/schemas/microsoft.graph.passkeyType'
publicKeyCredential:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredential'
additionalProperties:
type: object
microsoft.graph.authenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethod
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Represents the date and time when an entity was created. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.microsoftAuthenticatorAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: microsoftAuthenticatorAuthenticationMethod
type: object
properties:
deviceTag:
type: string
description: Tags containing app metadata.
nullable: true
displayName:
type: string
description: The name of the device on which this app is registered.
nullable: true
phoneAppVersion:
type: string
description: Numerical version of this instance of the Authenticator app.
nullable: true
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.longRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: longRunningOperation
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The time of the last action in the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
resourceLocation:
type: string
description: URI of the resource that the operation is performed on.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus'
statusDetail:
type: string
description: Details about the status of the operation.
nullable: true
additionalProperties:
type: object
description: The status of a long-running operation.
microsoft.graph.passwordAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: passwordAuthenticationMethod
type: object
properties:
password:
type: string
description: 'For security, the password is always returned as null from a LIST or GET operation.'
nullable: true
additionalProperties:
type: object
microsoft.graph.phoneAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: phoneAuthenticationMethod
type: object
properties:
phoneNumber:
type: string
description: 'The phone number to text or call for authentication. Phone numbers use the format +{country code} {number}x{extension}, with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating or updating if they don''t match the required format.'
nullable: true
phoneType:
$ref: '#/components/schemas/microsoft.graph.authenticationPhoneType'
smsSignInState:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodSignInState'
additionalProperties:
type: object
microsoft.graph.platformCredentialAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: platformCredentialAuthenticationMethod
type: object
properties:
displayName:
type: string
description: The name of the device on which Platform Credential is registered.
nullable: true
keyStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
platform:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodPlatform'
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.softwareOathAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: softwareOathAuthenticationMethod
type: object
properties:
secretKey:
type: string
description: The secret key of the method. Always returns null.
nullable: true
additionalProperties:
type: object
microsoft.graph.temporaryAccessPassAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: temporaryAccessPassAuthenticationMethod
type: object
properties:
isUsable:
type: boolean
description: The state of the authentication method that indicates whether it's currently usable by the user.
nullable: true
isUsableOnce:
type: boolean
description: 'Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime.'
nullable: true
lifetimeInMinutes:
maximum: 2147483647
minimum: -2147483648
type: number
description: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
format: int32
nullable: true
methodUsabilityReason:
type: string
description: 'Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.'
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
format: date-time
nullable: true
temporaryAccessPass:
type: string
description: The Temporary Access Pass used to authenticate. Returned only on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden in subsequent read operations and returned as null with GET.
nullable: true
additionalProperties:
type: object
microsoft.graph.windowsHelloForBusinessAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: windowsHelloForBusinessAuthenticationMethod
type: object
properties:
displayName:
type: string
description: The name of the device on which Windows Hello for Business is registered
nullable: true
keyStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.onlineMeetingProviderType:
title: onlineMeetingProviderType
enum:
- unknown
- skypeForBusiness
- skypeForConsumer
- teamsForBusiness
type: string
microsoft.graph.calendarColor:
title: calendarColor
enum:
- auto
- lightBlue
- lightGreen
- lightOrange
- lightGray
- lightYellow
- lightTeal
- lightPink
- lightBrown
- lightRed
- maxColor
type: string
microsoft.graph.emailAddress:
title: emailAddress
type: object
properties:
address:
type: string
description: The email address of the person or entity.
nullable: true
name:
type: string
description: The display name of the person or entity.
nullable: true
additionalProperties:
type: object
microsoft.graph.calendarPermission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarPermission
type: object
properties:
allowedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
description: 'List of allowed sharing or delegating permission levels for the calendar. The possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.'
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
isInsideOrganization:
type: boolean
description: True if the user in context (recipient or delegate) is inside the same organization as the calendar owner.
nullable: true
isRemovable:
type: boolean
description: 'True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The ''My organization'' user determines the permissions other people within your organization have to the given calendar. You can''t remove ''My organization'' as a share recipient to a calendar.'
nullable: true
role:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
additionalProperties:
type: object
microsoft.graph.multiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
items:
type: string
nullable: true
description: A collection of property values.
additionalProperties:
type: object
microsoft.graph.singleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
description: A property value.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookItem
type: object
properties:
categories:
type: array
items:
type: string
nullable: true
description: The categories associated with the item
changeKey:
type: string
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.attendee:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
- title: attendee
type: object
properties:
proposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
status:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
additionalProperties:
type: object
microsoft.graph.itemBody:
title: itemBody
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
$ref: '#/components/schemas/microsoft.graph.bodyType'
additionalProperties:
type: object
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
description: 'A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).'
timeZone:
type: string
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
nullable: true
additionalProperties:
type: object
microsoft.graph.importance:
title: importance
enum:
- low
- normal
- high
type: string
microsoft.graph.location:
title: location
type: object
properties:
address:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
coordinates:
$ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates'
displayName:
type: string
description: The name associated with the location.
nullable: true
locationEmailAddress:
type: string
description: Optional email address of the location.
nullable: true
locationType:
$ref: '#/components/schemas/microsoft.graph.locationType'
locationUri:
type: string
description: Optional URI representing the location.
nullable: true
uniqueId:
type: string
description: For internal use only.
nullable: true
uniqueIdType:
$ref: '#/components/schemas/microsoft.graph.locationUniqueIdType'
additionalProperties:
type: object
microsoft.graph.onlineMeetingInfo:
title: onlineMeetingInfo
type: object
properties:
conferenceId:
type: string
description: The ID of the conference.
nullable: true
joinUrl:
type: string
description: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.
nullable: true
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: All of the phone numbers associated with this conference.
quickDial:
type: string
description: The preformatted quick dial for this call.
nullable: true
tollFreeNumbers:
type: array
items:
type: string
nullable: true
description: The toll free numbers that can be used to join the conference.
tollNumber:
type: string
description: The toll number that can be used to join the conference.
nullable: true
additionalProperties:
type: object
microsoft.graph.recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.responseStatus:
title: responseStatus
type: object
properties:
response:
$ref: '#/components/schemas/microsoft.graph.responseType'
time:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.sensitivity:
title: sensitivity
enum:
- normal
- personal
- private
- confidential
type: string
microsoft.graph.freeBusyStatus:
title: freeBusyStatus
enum:
- unknown
- free
- tentative
- busy
- oof
- workingElsewhere
type: string
microsoft.graph.eventType:
title: eventType
enum:
- singleInstance
- occurrence
- exception
- seriesMaster
type: string
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false.'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
name:
type: string
description: The attachment's file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: number
description: The length of the attachment in bytes.
format: int32
additionalProperties:
type: object
microsoft.graph.chatType:
title: chatType
enum:
- oneOnOne
- group
- meeting
- unknownFutureValue
type: string
microsoft.graph.migrationMode:
title: migrationMode
enum:
- inProgress
- completed
- unknownFutureValue
type: string
microsoft.graph.teamworkOnlineMeetingInfo:
title: teamworkOnlineMeetingInfo
type: object
properties:
calendarEventId:
type: string
description: The identifier of the calendar event associated with the meeting.
nullable: true
joinWebUrl:
type: string
description: The URL that users click to join or uniquely identify the meeting.
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.teamworkUserIdentity'
additionalProperties:
type: object
microsoft.graph.chatViewpoint:
title: chatViewpoint
type: object
properties:
isHidden:
type: boolean
description: Indicates whether the chat is hidden for the current user.
nullable: true
lastMessageReadDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.teamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppInstallation
type: object
properties:
consentedPermissionSet:
$ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'
teamsApp:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
teamsAppDefinition:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
additionalProperties:
type: object
microsoft.graph.chatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessageInfo
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date time object representing the time at which message was created.
format: date-time
nullable: true
eventDetail:
$ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
from:
$ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
isDeleted:
type: boolean
description: 'If set to true, the original message has been deleted.'
nullable: true
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
additionalProperties:
type: object
microsoft.graph.conversationMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationMember
type: object
properties:
displayName:
type: string
description: The display name of the user.
nullable: true
roles:
type: array
items:
type: string
nullable: true
description: 'The roles for that user. This property contains more qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member shouldn''t have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.'
visibleHistoryStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessage
type: object
properties:
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageAttachment'
description: 'References to attached objects like files, tabs, meetings etc.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
channelIdentity:
$ref: '#/components/schemas/microsoft.graph.channelIdentity'
chatId:
type: string
description: 'If the message was sent in a chat, represents the identity of the chat.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp of when the chat message was created.
format: date-time
nullable: true
deletedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read-only. Timestamp at which the chat message was deleted, or null if not deleted.'
format: date-time
nullable: true
etag:
type: string
description: Read-only. Version number of the chat message.
nullable: true
eventDetail:
$ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
from:
$ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
importance:
$ref: '#/components/schemas/microsoft.graph.chatMessageImportance'
lastEditedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Read-only. Timestamp when edits to the chat message were made. Triggers an 'Edited' flag in the Teams UI. If no edits are made the value is null.
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read-only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.'
format: date-time
nullable: true
locale:
type: string
description: Locale of the chat message set by the client. Always set to en-us.
mentions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageMention'
description: 'List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.'
messageHistory:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHistoryItem'
description: 'List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.'
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
policyViolation:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolation'
reactions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
description: 'Reactions for this chat message (for example, Like).'
replyToId:
type: string
description: 'Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)'
nullable: true
subject:
type: string
description: 'The subject of the chat message, in plaintext.'
nullable: true
summary:
type: string
description: 'Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.'
nullable: true
webUrl:
type: string
description: Read-only. Link to the message in Microsoft Teams.
nullable: true
hostedContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.'
x-ms-navigationProperty: true
replies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: Replies for a specified message. Supports $expand for channel messages.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.pinnedChatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: pinnedChatMessageInfo
type: object
properties:
message:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
additionalProperties:
type: object
microsoft.graph.teamsTab:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTab
type: object
properties:
configuration:
$ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
displayName:
type: string
description: Name of the tab.
nullable: true
webUrl:
type: string
description: Deep link URL of the tab instance. Read-only.
nullable: true
teamsApp:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
additionalProperties:
type: object
microsoft.graph.targetedChatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
- title: targetedChatMessage
type: object
properties:
recipient:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.cloudClipboardItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardItem
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Set by the server. DateTime in UTC when the object expires and after that the object is no longer available. The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.'
format: date-time
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server if not provided in the client's request. DateTime in UTC when the object was modified by the client.
format: date-time
nullable: true
payloads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItemPayload'
description: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads. A window can place more than one clipboard object on the clipboard. Each one represents the same information in a different clipboard format.
additionalProperties:
type: object
microsoft.graph.cloudPcProvisioningType:
title: cloudPcProvisioningType
enum:
- dedicated
- shared
- unknownFutureValue
type: string
microsoft.graph.physicalAddress:
title: physicalAddress
type: object
properties:
city:
type: string
description: The city.
nullable: true
countryOrRegion:
type: string
description: 'The country or region. It''s a free-format string value, for example, ''United States''.'
nullable: true
postalCode:
type: string
description: The postal code.
nullable: true
state:
type: string
description: The state.
nullable: true
street:
type: string
description: The street.
nullable: true
additionalProperties:
type: object
microsoft.graph.dataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: dataSecurityAndGovernance
type: object
properties:
sensitivityLabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.activitiesContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activitiesContainer
type: object
properties:
contentActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
description: Collection of activity logs related to content processing.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userProtectionScopeContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userProtectionScopeContainer
type: object
additionalProperties:
type: object
microsoft.graph.baseItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of item creation. Read-only.
format: date-time
description:
type: string
description: Provides a user-visible description of the item. Optional.
nullable: true
eTag:
type: string
description: ETag for the item. Read-only.
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time the item was last modified. Read-only.
format: date-time
name:
type: string
description: The name of the item. Read-write.
nullable: true
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
webUrl:
type: string
description: 'URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.'
nullable: true
createdByUser:
$ref: '#/components/schemas/microsoft.graph.user'
lastModifiedByUser:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
microsoft.graph.quota:
title: quota
type: object
properties:
deleted:
type: number
description: 'Total space consumed by files in the recycle bin, in bytes. Read-only.'
format: int64
nullable: true
remaining:
type: number
description: 'Total space remaining before reaching the capacity limit, in bytes. Read-only.'
format: int64
nullable: true
state:
type: string
description: Enumeration value that indicates the state of the storage space. Read-only.
nullable: true
storagePlanInformation:
$ref: '#/components/schemas/microsoft.graph.storagePlanInformation'
total:
type: number
description: 'Total allowed storage space, in bytes. Read-only.'
format: int64
nullable: true
used:
type: number
description: 'Total space used, in bytes. Read-only.'
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.sharepointIds:
title: sharepointIds
type: object
properties:
listId:
type: string
description: The unique identifier (guid) for the item's list in SharePoint.
nullable: true
listItemId:
type: string
description: An integer identifier for the item within the containing list.
nullable: true
listItemUniqueId:
type: string
description: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
nullable: true
siteId:
type: string
description: The unique identifier (guid) for the item's site collection (SPSite).
nullable: true
siteUrl:
type: string
description: The SharePoint URL for the site that contains the item.
nullable: true
tenantId:
type: string
description: The unique identifier (guid) for the tenancy.
nullable: true
webId:
type: string
description: The unique identifier (guid) for the item's site (SPWeb).
nullable: true
additionalProperties:
type: object
microsoft.graph.systemFacet:
title: systemFacet
type: object
additionalProperties:
type: object
microsoft.graph.driveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: driveItem
type: object
properties:
audio:
$ref: '#/components/schemas/microsoft.graph.audio'
bundle:
$ref: '#/components/schemas/microsoft.graph.bundle'
content:
type: string
description: 'The content stream, if the item represents a file.'
format: base64url
nullable: true
cTag:
type: string
description: An eTag for the content of the item. This eTag isn't changed if only the metadata is changed. Note This property isn't returned if the item is a folder. Read-only.
nullable: true
deleted:
$ref: '#/components/schemas/microsoft.graph.deleted'
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
image:
$ref: '#/components/schemas/microsoft.graph.image'
location:
$ref: '#/components/schemas/microsoft.graph.geoCoordinates'
malware:
$ref: '#/components/schemas/microsoft.graph.malware'
package:
$ref: '#/components/schemas/microsoft.graph.package'
pendingOperations:
$ref: '#/components/schemas/microsoft.graph.pendingOperations'
photo:
$ref: '#/components/schemas/microsoft.graph.photo'
publication:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
remoteItem:
$ref: '#/components/schemas/microsoft.graph.remoteItem'
root:
$ref: '#/components/schemas/microsoft.graph.root'
searchResult:
$ref: '#/components/schemas/microsoft.graph.searchResult'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: number
description: Size of the item in bytes. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: WebDAV compatible URL for the item.
nullable: true
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
x-ms-navigationProperty: true
listItem:
$ref: '#/components/schemas/microsoft.graph.listItem'
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
retentionLabel:
$ref: '#/components/schemas/microsoft.graph.itemRetentionLabel'
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the item. Only supported on the root of a drive.
x-ms-navigationProperty: true
thumbnails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
description: 'Collection of thumbnailSet objects associated with the item. For more information, see getting thumbnails. Read-only. Nullable.'
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItemVersion'
description: 'The list of previous versions of the item. For more info, see getting previous versions. Read-only. Nullable.'
x-ms-navigationProperty: true
workbook:
$ref: '#/components/schemas/microsoft.graph.workbook'
additionalProperties:
type: object
microsoft.graph.list:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: list
type: object
properties:
displayName:
type: string
description: The displayable title of the list.
nullable: true
list:
$ref: '#/components/schemas/microsoft.graph.listInfo'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of field definitions for this list.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types present in this list.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItem'
description: All items contained in the list.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the list.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the list.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.engagementRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: engagementRole
type: object
properties:
displayName:
type: string
description: The name of the role.
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
description: Users that have this role assigned.
x-ms-navigationProperty: true
additionalProperties:
type: object
description: Represents a Viva Engage role and its members
microsoft.graph.learningCourseActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: learningCourseActivity
type: object
properties:
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time when the assignment was completed. Optional.
format: date-time
nullable: true
completionPercentage:
maximum: 2147483647
minimum: -2147483648
type: number
description: The percentage completion value of the course activity. Optional.
format: int32
nullable: true
externalcourseActivityId:
type: string
nullable: true
learnerUserId:
type: string
description: The user ID of the learner to whom the activity is assigned. Required.
learningContentId:
type: string
description: The ID of the learning content created in Viva Learning. Required.
learningProviderId:
type: string
description: The registration ID of the provider. Required.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.courseStatus'
additionalProperties:
type: object
microsoft.graph.publicError:
title: publicError
type: object
properties:
code:
type: string
description: Represents the error code.
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
description: Details of the error.
innerError:
$ref: '#/components/schemas/microsoft.graph.publicInnerError'
message:
type: string
description: A non-localized message for the developer.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.root:
title: root
type: object
additionalProperties:
type: object
microsoft.graph.siteCollection:
title: siteCollection
type: object
properties:
archivalDetails:
$ref: '#/components/schemas/microsoft.graph.siteArchivalDetails'
dataLocationCode:
type: string
description: The geographic region code for where this site collection resides. Only present for multi-geo tenants. Read-only.
nullable: true
hostname:
type: string
description: The hostname for the site collection. Read-only.
nullable: true
root:
$ref: '#/components/schemas/microsoft.graph.root'
additionalProperties:
type: object
microsoft.graph.itemAnalytics:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemAnalytics
type: object
properties:
allTime:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
itemActivityStats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
x-ms-navigationProperty: true
lastSevenDays:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
additionalProperties:
type: object
microsoft.graph.columnDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnDefinition
type: object
properties:
boolean:
$ref: '#/components/schemas/microsoft.graph.booleanColumn'
calculated:
$ref: '#/components/schemas/microsoft.graph.calculatedColumn'
choice:
$ref: '#/components/schemas/microsoft.graph.choiceColumn'
columnGroup:
type: string
description: 'For site columns, the name of the group this column belongs to. Helps organize related columns.'
nullable: true
contentApprovalStatus:
$ref: '#/components/schemas/microsoft.graph.contentApprovalStatusColumn'
currency:
$ref: '#/components/schemas/microsoft.graph.currencyColumn'
dateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeColumn'
defaultValue:
$ref: '#/components/schemas/microsoft.graph.defaultColumnValue'
description:
type: string
description: The user-facing description of the column.
nullable: true
displayName:
type: string
description: The user-facing name of the column.
nullable: true
enforceUniqueValues:
type: boolean
description: 'If true, no two list items may have the same value for this column.'
nullable: true
geolocation:
$ref: '#/components/schemas/microsoft.graph.geolocationColumn'
hidden:
type: boolean
description: Specifies whether the column is displayed in the user interface.
nullable: true
hyperlinkOrPicture:
$ref: '#/components/schemas/microsoft.graph.hyperlinkOrPictureColumn'
indexed:
type: boolean
description: Specifies whether the column values can be used for sorting and searching.
nullable: true
isDeletable:
type: boolean
description: Indicates whether this column can be deleted.
nullable: true
isReorderable:
type: boolean
description: Indicates whether values in the column can be reordered. Read-only.
nullable: true
isSealed:
type: boolean
description: Specifies whether the column can be changed.
nullable: true
lookup:
$ref: '#/components/schemas/microsoft.graph.lookupColumn'
name:
type: string
description: 'The API-facing name of the column as it appears in the fields on a listItem. For the user-facing name, see displayName.'
nullable: true
number:
$ref: '#/components/schemas/microsoft.graph.numberColumn'
personOrGroup:
$ref: '#/components/schemas/microsoft.graph.personOrGroupColumn'
propagateChanges:
type: boolean
description: 'If ''true'', changes to this column will be propagated to lists that implement the column.'
nullable: true
readOnly:
type: boolean
description: Specifies whether the column values can be modified.
nullable: true
required:
type: boolean
description: Specifies whether the column value isn't optional.
nullable: true
sourceContentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
term:
$ref: '#/components/schemas/microsoft.graph.termColumn'
text:
$ref: '#/components/schemas/microsoft.graph.textColumn'
thumbnail:
$ref: '#/components/schemas/microsoft.graph.thumbnailColumn'
type:
$ref: '#/components/schemas/microsoft.graph.columnTypes'
validation:
$ref: '#/components/schemas/microsoft.graph.columnValidation'
sourceColumn:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
additionalProperties:
type: object
microsoft.graph.contentType:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentType
type: object
properties:
associatedHubsUrls:
type: array
items:
type: string
nullable: true
description: List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type is applied to the lists in the enforced sites.
description:
type: string
description: The descriptive text for the item.
nullable: true
documentSet:
$ref: '#/components/schemas/microsoft.graph.documentSet'
documentTemplate:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
group:
type: string
description: The name of the group this content type belongs to. Helps organize related content types.
nullable: true
hidden:
type: boolean
description: Indicates whether the content type is hidden in the list's 'New' menu.
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
isBuiltIn:
type: boolean
description: Specifies if a content type is a built-in content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
order:
$ref: '#/components/schemas/microsoft.graph.contentTypeOrder'
parentId:
type: string
description: The unique identifier of the content type.
nullable: true
propagateChanges:
type: boolean
description: 'If true, any changes made to the content type are pushed to inherited content types and lists that implement the content type.'
nullable: true
readOnly:
type: boolean
description: 'If true, the content type can''t be modified unless this value is first set to false.'
nullable: true
sealed:
type: boolean
description: 'If true, the content type can''t be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.'
nullable: true
base:
$ref: '#/components/schemas/microsoft.graph.contentType'
baseTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types that are ancestors of this content type.
x-ms-navigationProperty: true
columnLinks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnLink'
description: The collection of columns that are required by this content type.
x-ms-navigationProperty: true
columnPositions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: Column order information in a content type.
x-ms-navigationProperty: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions for this content type.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
percentageComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: A value between 0 and 100 that indicates the progress of the operation.
format: int32
nullable: true
resourceId:
type: string
description: The unique identifier for the result.
nullable: true
type:
type: string
description: The type of the operation.
nullable: true
additionalProperties:
type: object
description: The status of a long-running operation.
microsoft.graph.baseSitePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: baseSitePage
type: object
properties:
pageLayout:
$ref: '#/components/schemas/microsoft.graph.pageLayoutType'
publishingState:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
title:
type: string
description: Title of the sitePage.
nullable: true
additionalProperties:
type: object
microsoft.graph.permission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: permission
type: object
properties:
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there's no expiration set for this permission. Optional.
format: date-time
nullable: true
grantedTo:
$ref: '#/components/schemas/microsoft.graph.identitySet'
grantedToIdentities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identitySet'
description: 'For type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToIdentitiesV2:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
description: 'For link type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToV2:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
hasPassword:
type: boolean
description: Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only..
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
invitation:
$ref: '#/components/schemas/microsoft.graph.sharingInvitation'
link:
$ref: '#/components/schemas/microsoft.graph.sharingLink'
roles:
type: array
items:
type: string
nullable: true
description: 'The type of permission, for example, read. See below for the full list of roles. Read-only.'
shareId:
type: string
description: A unique token that can be used to access this shared item via the shares API. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.store:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: store
type: object
properties:
defaultLanguageTag:
type: string
description: Default language of the term store.
languageTags:
type: array
items:
type: string
description: List of languages for the term store.
groups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.group'
description: Collection of all groups available in the term store.
x-ms-navigationProperty: true
sets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
description: Collection of all sets available in the term store. This relationship can only be used to load a specific term set.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.inferenceClassificationOverride:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassificationOverride
type: object
properties:
classifyAs:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
senderEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.officeGraphInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: officeGraphInsights
type: object
properties:
shared:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
description: 'Calculated relationship that identifies documents shared with or by the user. This includes URLs, file attachments, and reference attachments to OneDrive for work or school and SharePoint files found in Outlook messages and meetings. This also includes URLs and reference attachments to Teams conversations. Ordered by recency of share.'
x-ms-navigationProperty: true
trending:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.trending'
description: 'Calculated relationship that identifies documents trending around a user. Trending documents are calculated based on activity of the user''s closest network of people and include files stored in OneDrive for work or school and SharePoint. Trending insights help the user to discover potentially useful content that the user has access to, but has never viewed before.'
x-ms-navigationProperty: true
used:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
description: 'Calculated relationship that identifies the latest documents viewed or modified by a user, including OneDrive for work or school and SharePoint documents, ranked by recency of use.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamFunSettings:
title: teamFunSettings
type: object
properties:
allowCustomMemes:
type: boolean
description: 'If set to true, enables users to include custom memes.'
nullable: true
allowGiphy:
type: boolean
description: 'If set to true, enables Giphy use.'
nullable: true
allowStickersAndMemes:
type: boolean
description: 'If set to true, enables users to include stickers and memes.'
nullable: true
giphyContentRating:
$ref: '#/components/schemas/microsoft.graph.giphyRatingType'
additionalProperties:
type: object
microsoft.graph.teamGuestSettings:
title: teamGuestSettings
type: object
properties:
allowCreateUpdateChannels:
type: boolean
description: 'If set to true, guests can add and update channels.'
nullable: true
allowDeleteChannels:
type: boolean
description: 'If set to true, guests can delete channels.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamMemberSettings:
title: teamMemberSettings
type: object
properties:
allowAddRemoveApps:
type: boolean
description: 'If set to true, members can add and remove apps.'
nullable: true
allowCreatePrivateChannels:
type: boolean
description: 'If set to true, members can add and update private channels.'
nullable: true
allowCreateUpdateChannels:
type: boolean
description: 'If set to true, members can add and update channels.'
nullable: true
allowCreateUpdateRemoveConnectors:
type: boolean
description: 'If set to true, members can add, update, and remove connectors.'
nullable: true
allowCreateUpdateRemoveTabs:
type: boolean
description: 'If set to true, members can add, update, and remove tabs.'
nullable: true
allowDeleteChannels:
type: boolean
description: 'If set to true, members can delete channels.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamMessagingSettings:
title: teamMessagingSettings
type: object
properties:
allowChannelMentions:
type: boolean
description: 'If set to true, @channel mentions are allowed.'
nullable: true
allowOwnerDeleteMessages:
type: boolean
description: 'If set to true, owners can delete any message.'
nullable: true
allowTeamMentions:
type: boolean
description: 'If set to true, @team mentions are allowed.'
nullable: true
allowUserDeleteMessages:
type: boolean
description: 'If set to true, users can delete their messages.'
nullable: true
allowUserEditMessages:
type: boolean
description: 'If set to true, users can edit their messages.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamSpecialization:
title: teamSpecialization
enum:
- none
- educationStandard
- educationClass
- educationProfessionalLearningCommunity
- educationStaff
- healthcareStandard
- healthcareCareCoordination
- unknownFutureValue
type: string
microsoft.graph.teamSummary:
title: teamSummary
type: object
properties:
guestsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of guests in a team.
format: int32
nullable: true
membersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of members in a team.
format: int32
nullable: true
ownersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of owners in a team.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.teamVisibilityType:
title: teamVisibilityType
enum:
- private
- public
- hiddenMembership
- unknownFutureValue
type: string
microsoft.graph.channel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: channel
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Read-only. Timestamp at which the channel was created.
format: date-time
nullable: true
description:
type: string
description: Optional textual description for the channel.
nullable: true
displayName:
type: string
description: Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
email:
type: string
description: The email address for sending messages to the channel. Read-only.
nullable: true
isArchived:
type: boolean
description: Indicates whether the channel is archived. Read-only.
nullable: true
isFavoriteByDefault:
type: boolean
description: 'Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false.'
nullable: true
layoutType:
$ref: '#/components/schemas/microsoft.graph.channelLayoutType'
membershipType:
$ref: '#/components/schemas/microsoft.graph.channelMembershipType'
migrationMode:
$ref: '#/components/schemas/microsoft.graph.migrationMode'
originalCreatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp of the original creation time for the channel. The value is null if the channel never entered migration mode.
format: date-time
nullable: true
summary:
$ref: '#/components/schemas/microsoft.graph.channelSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
webUrl:
type: string
description: 'A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
allMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: 'A collection of membership records associated with the channel, including both direct and indirect members of shared channels.'
x-ms-navigationProperty: true
enabledApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
description: A collection of enabled apps in the channel.
x-ms-navigationProperty: true
filesFolder:
$ref: '#/components/schemas/microsoft.graph.driveItem'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of membership records associated with the channel.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the channel. A navigation property. Nullable.
x-ms-navigationProperty: true
sharedWithTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
description: A collection of teams with which a channel is shared.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the channel. A navigation property.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsAsyncOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAsyncOperation
type: object
properties:
attemptsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of times the operation was attempted before being marked successful or failed.
format: int32
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time when the operation was created.
format: date-time
error:
$ref: '#/components/schemas/microsoft.graph.operationError'
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time when the async operation was last updated.
format: date-time
operationType:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType'
status:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus'
targetResourceId:
type: string
description: 'The ID of the object that''s created or modified as result of this async operation, typically a team.'
nullable: true
targetResourceLocation:
type: string
description: The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
nullable: true
additionalProperties:
type: object
microsoft.graph.schedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: schedule
type: object
properties:
enabled:
type: boolean
description: Indicates whether the schedule is enabled for the team. Required.
nullable: true
isActivitiesIncludedWhenCopyingShiftsEnabled:
type: boolean
description: Indicates whether copied shifts include activities from the original shift.
nullable: true
offerShiftRequestsEnabled:
type: boolean
description: Indicates whether offer shift requests are enabled for the schedule.
nullable: true
openShiftsEnabled:
type: boolean
description: Indicates whether open shifts are enabled for the schedule.
nullable: true
provisionStatus:
$ref: '#/components/schemas/microsoft.graph.operationStatus'
provisionStatusCode:
type: string
description: Additional information about why schedule provisioning failed.
nullable: true
readOnly: true
startDayOfWeek:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
swapShiftsRequestsEnabled:
type: boolean
description: Indicates whether swap shifts requests are enabled for the schedule.
nullable: true
timeClockEnabled:
type: boolean
description: Indicates whether time clock is enabled for the schedule.
nullable: true
timeClockSettings:
$ref: '#/components/schemas/microsoft.graph.timeClockSettings'
timeOffRequestsEnabled:
type: boolean
description: Indicates whether time off requests are enabled for the schedule.
nullable: true
timeZone:
type: string
description: 'The time zone of the schedule team as an IANA time zone database (tz database) name; for example, America/Chicago. For the full list of valid values, see List of tz database time zones. Required.'
nullable: true
workforceIntegrationIds:
type: array
items:
type: string
nullable: true
description: The IDs for the workforce integrations associated with this schedule.
dayNotes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayNote'
description: The day notes in the schedule.
x-ms-navigationProperty: true
offerShiftRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
description: The offer requests for shifts in the schedule.
x-ms-navigationProperty: true
openShiftChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
description: The open shift requests in the schedule.
x-ms-navigationProperty: true
openShifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShift'
description: The set of open shifts in a scheduling group in the schedule.
x-ms-navigationProperty: true
schedulingGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
description: The logical grouping of users in the schedule (usually by role).
x-ms-navigationProperty: true
shifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shift'
description: The shifts in the schedule.
x-ms-navigationProperty: true
swapShiftsChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
description: The swap requests for shifts in the schedule.
x-ms-navigationProperty: true
timeCards:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeCard'
description: The time cards in the schedule.
x-ms-navigationProperty: true
timeOffReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
description: The set of reasons for a time off in the schedule.
x-ms-navigationProperty: true
timeOffRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
description: The time off requests in the schedule.
x-ms-navigationProperty: true
timesOff:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOff'
description: The instances of times off in the schedule.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamworkTag:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkTag
type: object
properties:
description:
type: string
description: The description of the tag as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
nullable: true
displayName:
type: string
description: The name of the tag as it appears to the user in Microsoft Teams.
nullable: true
memberCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of users assigned to the tag.
format: int32
nullable: true
tagType:
$ref: '#/components/schemas/microsoft.graph.teamworkTagType'
teamId:
type: string
description: ID of the team in which the tag is defined.
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
description: Users assigned to the tag.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTemplate
type: object
additionalProperties:
type: object
microsoft.graph.servicePlanInfo:
title: servicePlanInfo
type: object
properties:
appliesTo:
type: string
description: The object the service plan can be assigned to. The possible values are:User - service plan can be assigned to individual users.Company - service plan can be assigned to the entire tenant.
nullable: true
provisioningStatus:
type: string
description: 'The provisioning status of the service plan. The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn''t provisioned and is in an error state.PendingInput - The service isn''t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn''t activated in the tenant.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier of the service plan.
format: uuid
nullable: true
servicePlanName:
type: string
description: The name of the service plan.
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: messageRule
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.messageRuleActions'
conditions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
displayName:
type: string
description: The display name of the rule.
nullable: true
exceptions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
hasError:
type: boolean
description: Indicates whether the rule is in an error condition. Read-only.
nullable: true
isEnabled:
type: boolean
description: Indicates whether the rule is enabled to be applied to messages.
nullable: true
isReadOnly:
type: boolean
description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
nullable: true
sequence:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Indicates the order in which the rule is executed, among other rules.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.mobileAppIdentifier:
title: mobileAppIdentifier
type: object
additionalProperties:
type: object
description: The identifier for a mobile app.
microsoft.graph.managedAppFlaggedReason:
title: managedAppFlaggedReason
enum:
- none
- rootedDevice
type: string
description: The reason for which a user has been flagged
x-ms-enum:
name: managedAppFlaggedReason
modelAsString: false
values:
- value: none
description: No issue.
name: none
- value: rootedDevice
description: The app registration is running on a rooted/unlocked device.
name: rootedDevice
microsoft.graph.managedAppPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppPolicy
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time the policy was created.
format: date-time
description:
type: string
description: The policy's description.
nullable: true
displayName:
type: string
description: Policy display name.
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last time the policy was modified.
format: date-time
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties:
type: object
description: The ManagedAppPolicy resource represents a base type for platform specific policies.
microsoft.graph.managedAppOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppOperation
type: object
properties:
displayName:
type: string
description: The operation name.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The last time the app operation was modified.
format: date-time
state:
type: string
description: The current state of the operation
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties:
type: object
description: Represents an operation applied against an app registration.
microsoft.graph.complianceState:
title: complianceState
enum:
- unknown
- compliant
- noncompliant
- conflict
- error
- inGracePeriod
- configManager
type: string
description: Compliance state.
x-ms-enum:
name: complianceState
modelAsString: false
values:
- value: unknown
description: Unknown.
name: unknown
- value: compliant
description: Compliant.
name: compliant
- value: noncompliant
description: Device is non-compliant and is blocked from corporate resources.
name: noncompliant
- value: conflict
description: Conflict with other rules.
name: conflict
- value: error
description: Error.
name: error
- value: inGracePeriod
description: Device is non-compliant but still has access to corporate resources
name: inGracePeriod
- value: configManager
description: Managed by Config Manager
name: configManager
microsoft.graph.configurationManagerClientEnabledFeatures:
title: configurationManagerClientEnabledFeatures
type: object
properties:
compliancePolicy:
type: boolean
description: Whether compliance policy is managed by Intune
deviceConfiguration:
type: boolean
description: Whether device configuration is managed by Intune
inventory:
type: boolean
description: Whether inventory is managed by Intune
modernApps:
type: boolean
description: Whether modern application is managed by Intune
resourceAccess:
type: boolean
description: Whether resource access is managed by Intune
windowsUpdateForBusiness:
type: boolean
description: Whether Windows Update for Business is managed by Intune
additionalProperties:
type: object
description: configuration Manager client enabled features
microsoft.graph.deviceActionResult:
title: deviceActionResult
type: object
properties:
actionName:
type: string
description: Action name
nullable: true
actionState:
$ref: '#/components/schemas/microsoft.graph.actionState'
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time the action state was last updated
format: date-time
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time the action was initiated
format: date-time
additionalProperties:
type: object
description: Device action result
microsoft.graph.deviceEnrollmentType:
title: deviceEnrollmentType
enum:
- unknown
- userEnrollment
- deviceEnrollmentManager
- appleBulkWithUser
- appleBulkWithoutUser
- windowsAzureADJoin
- windowsBulkUserless
- windowsAutoEnrollment
- windowsBulkAzureDomainJoin
- windowsCoManagement
- windowsAzureADJoinUsingDeviceAuth
- appleUserEnrollment
- appleUserEnrollmentWithServiceAccount
- unknownFutureValue
type: string
description: Possible ways of adding a mobile device to management.
x-ms-enum:
name: deviceEnrollmentType
modelAsString: false
values:
- value: unknown
description: 'Default value, enrollment type was not collected.'
name: unknown
- value: userEnrollment
description: User driven enrollment through BYOD channel.
name: userEnrollment
- value: deviceEnrollmentManager
description: User enrollment with a device enrollment manager account.
name: deviceEnrollmentManager
- value: appleBulkWithUser
description: 'Apple bulk enrollment with user challenge. (DEP, Apple Configurator)'
name: appleBulkWithUser
- value: appleBulkWithoutUser
description: 'Apple bulk enrollment without user challenge. (DEP, Apple Configurator, Mobile Config)'
name: appleBulkWithoutUser
- value: windowsAzureADJoin
description: Windows 10 Entra ID (Azure AD) Join.
name: windowsAzureADJoin
- value: windowsBulkUserless
description: Windows 10 Bulk enrollment through ICD with certificate.
name: windowsBulkUserless
- value: windowsAutoEnrollment
description: Windows 10 automatic enrollment. (Add work account)
name: windowsAutoEnrollment
- value: windowsBulkAzureDomainJoin
description: Windows 10 bulk Entra ID (Azure AD) Join.
name: windowsBulkAzureDomainJoin
- value: windowsCoManagement
description: Windows 10 Co-Management triggered by AutoPilot or Group Policy.
name: windowsCoManagement
- value: windowsAzureADJoinUsingDeviceAuth
description: Windows 10 Entra ID (Azure AD) Join using Device Auth.
name: windowsAzureADJoinUsingDeviceAuth
- value: appleUserEnrollment
description: Indicates the device is enrolled via Apple User Enrollment with Company Portal. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities
name: appleUserEnrollment
- value: appleUserEnrollmentWithServiceAccount
description: Indicates the device is enrolled via Apple User Enrollment with Company Portal using a device enrollment manager user. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities
name: appleUserEnrollmentWithServiceAccount
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
microsoft.graph.deviceHealthAttestationState:
title: deviceHealthAttestationState
type: object
properties:
attestationIdentityKey:
type: string
description: 'TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.'
nullable: true
bitLockerStatus:
type: string
description: On or Off of BitLocker Drive Encryption
nullable: true
bootAppSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootDebugging:
type: string
description: 'When bootDebugging is enabled, the device is used in development and testing'
nullable: true
bootManagerSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootManagerVersion:
type: string
description: The version of the Boot Manager
nullable: true
bootRevisionListInfo:
type: string
description: The Boot Revision List that was loaded during initial boot on the attested device
nullable: true
codeIntegrity:
type: string
description: 'When code integrity is enabled, code execution is restricted to integrity verified code'
nullable: true
codeIntegrityCheckVersion:
type: string
description: The version of the Boot Manager
nullable: true
codeIntegrityPolicy:
type: string
description: The Code Integrity policy that is controlling the security of the boot environment
nullable: true
contentNamespaceUrl:
type: string
description: The DHA report version. (Namespace version)
nullable: true
contentVersion:
type: string
description: The HealthAttestation state schema version
nullable: true
dataExcutionPolicy:
type: string
description: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory
nullable: true
deviceHealthAttestationStatus:
type: string
description: The DHA report version. (Namespace version)
nullable: true
earlyLaunchAntiMalwareDriverProtection:
type: string
description: ELAM provides protection for the computers in your network when they start up
nullable: true
healthAttestationSupportedStatus:
type: string
description: This attribute indicates if DHA is supported for the device
nullable: true
healthStatusMismatchInfo:
type: string
description: This attribute appears if DHA-Service detects an integrity issue
nullable: true
issuedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime when device was evaluated or issued to MDM
format: date-time
lastUpdateDateTime:
type: string
description: The Timestamp of the last update.
nullable: true
operatingSystemKernelDebugging:
type: string
description: 'When operatingSystemKernelDebugging is enabled, the device is used in development and testing'
nullable: true
operatingSystemRevListInfo:
type: string
description: The Operating System Revision List that was loaded during initial boot on the attested device
nullable: true
pcr0:
type: string
description: 'The measurement that is captured in PCR[0]'
nullable: true
pcrHashAlgorithm:
type: string
description: Informational attribute that identifies the HASH algorithm that was used by TPM
nullable: true
resetCount:
type: number
description: The number of times a PC device has hibernated or resumed
format: int64
restartCount:
type: number
description: The number of times a PC device has rebooted
format: int64
safeMode:
type: string
description: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state
nullable: true
secureBoot:
type: string
description: 'When Secure Boot is enabled, the core components must have the correct cryptographic signatures'
nullable: true
secureBootConfigurationPolicyFingerPrint:
type: string
description: Fingerprint of the Custom Secure Boot Configuration Policy
nullable: true
testSigning:
type: string
description: 'When test signing is allowed, the device does not enforce signature validation during boot'
nullable: true
tpmVersion:
type: string
description: The security version number of the Boot Application
nullable: true
virtualSecureMode:
type: string
description: 'Indicates whether the device has Virtual Secure Mode (VSM) enabled. Virtual Secure Mode (VSM) is a container that protects high value assets from a compromised kernel. This property will be deprecated in beta from August 2023. Support for this property will end in August 2025 for v1.0 API. A new property virtualizationBasedSecurity is added and used instead. The value used for virtualSecureMode will be passed by virtualizationBasedSecurity during the deprecation process. Possible values are ''enabled'', ''disabled'' and ''notApplicable''. ''enabled'' indicates Virtual Secure Mode (VSM) is enabled. ''disabled'' indicates Virtual Secure Mode (VSM) is disabled. ''notApplicable'' indicates the device is not a Windows 11 device. Default value is ''notApplicable''.'
nullable: true
windowsPE:
type: string
description: Operating system running with limited services that is used to prepare a computer for Windows
nullable: true
additionalProperties:
type: object
microsoft.graph.deviceRegistrationState:
title: deviceRegistrationState
enum:
- notRegistered
- registered
- revoked
- keyConflict
- approvalPending
- certificateReset
- notRegisteredPendingEnrollment
- unknown
type: string
description: Device registration status.
x-ms-enum:
name: deviceRegistrationState
modelAsString: false
values:
- value: notRegistered
description: The device is not registered.
name: notRegistered
- value: registered
description: The device is registered.
name: registered
- value: revoked
description: 'The device has been blocked, wiped or retired.'
name: revoked
- value: keyConflict
description: The device has a key conflict.
name: keyConflict
- value: approvalPending
description: The device is pending approval.
name: approvalPending
- value: certificateReset
description: The device certificate has been reset.
name: certificateReset
- value: notRegisteredPendingEnrollment
description: The device is not registered and pending enrollment.
name: notRegisteredPendingEnrollment
- value: unknown
description: The device registration status is unknown.
name: unknown
microsoft.graph.deviceManagementExchangeAccessState:
title: deviceManagementExchangeAccessState
enum:
- none
- unknown
- allowed
- blocked
- quarantined
type: string
description: Device Exchange Access State.
x-ms-enum:
name: deviceManagementExchangeAccessState
modelAsString: false
values:
- value: none
description: No access state discovered from Exchange
name: none
- value: unknown
description: Device access state to Exchange is unknown
name: unknown
- value: allowed
description: Device has access to Exchange
name: allowed
- value: blocked
description: Device is Blocked in Exchange
name: blocked
- value: quarantined
description: Device is Quarantined in Exchange
name: quarantined
microsoft.graph.deviceManagementExchangeAccessStateReason:
title: deviceManagementExchangeAccessStateReason
enum:
- none
- unknown
- exchangeGlobalRule
- exchangeIndividualRule
- exchangeDeviceRule
- exchangeUpgrade
- exchangeMailboxPolicy
- other
- compliant
- notCompliant
- notEnrolled
- unknownLocation
- mfaRequired
- azureADBlockDueToAccessPolicy
- compromisedPassword
- deviceNotKnownWithManagedApp
type: string
description: Device Exchange Access State Reason.
x-ms-enum:
name: deviceManagementExchangeAccessStateReason
modelAsString: false
values:
- value: none
description: No access state reason discovered from Exchange
name: none
- value: unknown
description: Unknown access state reason
name: unknown
- value: exchangeGlobalRule
description: Access state determined by Exchange Global rule
name: exchangeGlobalRule
- value: exchangeIndividualRule
description: Access state determined by Exchange Individual rule
name: exchangeIndividualRule
- value: exchangeDeviceRule
description: Access state determined by Exchange Device rule
name: exchangeDeviceRule
- value: exchangeUpgrade
description: Access state due to Exchange upgrade
name: exchangeUpgrade
- value: exchangeMailboxPolicy
description: Access state determined by Exchange Mailbox Policy
name: exchangeMailboxPolicy
- value: other
description: Access state determined by Exchange
name: other
- value: compliant
description: Access state granted by compliance challenge
name: compliant
- value: notCompliant
description: Access state revoked by compliance challenge
name: notCompliant
- value: notEnrolled
description: Access state revoked by management challenge
name: notEnrolled
- value: unknownLocation
description: Access state due to unknown location
name: unknownLocation
- value: mfaRequired
description: Access state due to MFA challenge
name: mfaRequired
- value: azureADBlockDueToAccessPolicy
description: Access State revoked by AAD Access Policy
name: azureADBlockDueToAccessPolicy
- value: compromisedPassword
description: Access State revoked by compromised password
name: compromisedPassword
- value: deviceNotKnownWithManagedApp
description: Access state revoked by managed application challenge
name: deviceNotKnownWithManagedApp
microsoft.graph.managedDeviceOwnerType:
title: managedDeviceOwnerType
enum:
- unknown
- company
- personal
- unknownFutureValue
type: string
description: Owner type of device.
x-ms-enum:
name: managedDeviceOwnerType
modelAsString: false
values:
- value: unknown
description: Unknown device owner type.
name: unknown
- value: company
description: Corporate device owner type.
name: company
- value: personal
description: Personal device owner type.
name: personal
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
microsoft.graph.managementAgentType:
title: managementAgentType
enum:
- eas
- mdm
- easMdm
- intuneClient
- easIntuneClient
- configurationManagerClient
- configurationManagerClientMdm
- configurationManagerClientMdmEas
- unknown
- jamf
- googleCloudDevicePolicyController
- microsoft365ManagedMdm
- msSense
type: string
x-ms-enum:
name: managementAgentType
modelAsString: false
values:
- value: eas
description: The device is managed by Exchange server.
name: eas
- value: mdm
description: The device is managed by Intune MDM.
name: mdm
- value: easMdm
description: The device is managed by both Exchange server and Intune MDM.
name: easMdm
- value: intuneClient
description: Intune client managed.
name: intuneClient
- value: easIntuneClient
description: The device is EAS and Intune client dual managed.
name: easIntuneClient
- value: configurationManagerClient
description: The device is managed by Configuration Manager.
name: configurationManagerClient
- value: configurationManagerClientMdm
description: The device is managed by Configuration Manager and MDM.
name: configurationManagerClientMdm
- value: configurationManagerClientMdmEas
description: 'The device is managed by Configuration Manager, MDM and Eas.'
name: configurationManagerClientMdmEas
- value: unknown
description: Unknown management agent type.
name: unknown
- value: jamf
description: The device attributes are fetched from Jamf.
name: jamf
- value: googleCloudDevicePolicyController
description: The device is managed by Google's CloudDPC.
name: googleCloudDevicePolicyController
- value: microsoft365ManagedMdm
description: This device is managed by Microsoft 365 through Intune.
name: microsoft365ManagedMdm
microsoft.graph.managementState:
title: managementState
enum:
- managed
- retirePending
- retireFailed
- wipePending
- wipeFailed
- unhealthy
- deletePending
- retireIssued
- wipeIssued
- wipeCanceled
- retireCanceled
- discovered
- unknownFutureValue
type: string
description: Management state of device in Microsoft Intune.
x-ms-enum:
name: managementState
modelAsString: false
values:
- value: managed
description: The device is under management
name: managed
- value: retirePending
description: A retire command is occuring on the device and in the process of unenrolling from management
name: retirePending
- value: retireFailed
description: Retire command failed on the device
name: retireFailed
- value: wipePending
description: A wipe command is occuring on the device and in the process of unenrolling from management
name: wipePending
- value: wipeFailed
description: Wipe command failed on the device
name: wipeFailed
- value: unhealthy
description: The device is unhealthy.
name: unhealthy
- value: deletePending
description: 'A delete command is occuring on the device '
name: deletePending
- value: retireIssued
description: A retire command was issued for the device
name: retireIssued
- value: wipeIssued
description: A wipe command was issued for the device
name: wipeIssued
- value: wipeCanceled
description: A wipe command for this device has been canceled
name: wipeCanceled
- value: retireCanceled
description: A retire command for this device has been canceled
name: retireCanceled
- value: discovered
description: The device is discovered but not fully enrolled.
name: discovered
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
microsoft.graph.managedDevicePartnerReportedHealthState:
title: managedDevicePartnerReportedHealthState
enum:
- unknown
- activated
- deactivated
- secured
- lowSeverity
- mediumSeverity
- highSeverity
- unresponsive
- compromised
- misconfigured
type: string
description: Available health states for the Device Health API
x-ms-enum:
name: managedDevicePartnerReportedHealthState
modelAsString: false
values:
- value: unknown
description: Device health state is not yet reported
name: unknown
- value: activated
description: 'Device has been activated by a mobile threat defense partner, but has not yet reported health.'
name: activated
- value: deactivated
description: Device has been deactivated by a mobile threat defense partner. The device health is not known.
name: deactivated
- value: secured
description: Device is considered secured by the mobile threat defense partner.
name: secured
- value: lowSeverity
description: Device is considered low threat by the mobile threat defense partner.
name: lowSeverity
- value: mediumSeverity
description: Device is considered medium threat by the mobile threat defense partner.
name: mediumSeverity
- value: highSeverity
description: Device is considered high threat by the mobile threat defense partner.
name: highSeverity
- value: unresponsive
description: Device is considered unresponsive by the mobile threat defense partner. The device health is not known.
name: unresponsive
- value: compromised
description: Device is considered compromised by the Threat Defense partner. This means the device has an active Threat or Risk which cannot be easily remediated by the end user and the user should contact their IT Admin.
name: compromised
- value: misconfigured
description: Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.
name: misconfigured
microsoft.graph.deviceCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCategory
type: object
properties:
description:
type: string
description: Optional description for the device category.
nullable: true
displayName:
type: string
description: Display name for the device category.
nullable: true
additionalProperties:
type: object
description: 'Device categories provides a way to organize your devices. Using device categories, company administrators can define their own categories that make sense to their company. These categories can then be applied to a device in the Intune Azure console or selected by a user during device enrollment. You can filter reports and create dynamic Azure Active Directory device groups based on device categories.'
microsoft.graph.deviceCompliancePolicyState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCompliancePolicyState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.policyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicySettingState'
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
additionalProperties:
type: object
description: Device Compliance Policy State for a given device.
microsoft.graph.deviceConfigurationState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceConfigurationState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.policyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationSettingState'
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
additionalProperties:
type: object
description: Support for this Entity is being deprecated starting May 2026 & will no longer be supported.
microsoft.graph.deviceLogCollectionResponse:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceLogCollectionResponse
type: object
properties:
enrolledByUser:
type: string
description: The User Principal Name (UPN) of the user that enrolled the device.
nullable: true
expirationDateTimeUTC:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime of the expiration of the logs.
format: date-time
nullable: true
initiatedByUserPrincipalName:
type: string
description: The UPN for who initiated the request.
nullable: true
managedDeviceId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Indicates Intune device unique identifier.
format: uuid
receivedDateTimeUTC:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime the request was received.
format: date-time
nullable: true
requestedDateTimeUTC:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime of the request.
format: date-time
nullable: true
sizeInKB:
type: number
description: The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
format: double
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.appLogUploadState'
additionalProperties:
type: object
description: Windows Log Collection request entity.
microsoft.graph.windowsProtectionState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsProtectionState
type: object
properties:
antiMalwareVersion:
type: string
description: Current anti malware version
nullable: true
controlledConfigurationEnabled:
type: boolean
description: 'When TRUE indicates the Windows Defender controlled configuration feature is enabled, when FALSE indicates the Windows Defender controlled configuration feature is not enabled. Defaults to setting on client device.'
nullable: true
deviceState:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceHealthState'
engineVersion:
type: string
description: Current endpoint protection engine's version
nullable: true
fullScanOverdue:
type: boolean
description: 'When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.'
nullable: true
fullScanRequired:
type: boolean
description: 'When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.'
nullable: true
isVirtualMachine:
type: boolean
description: 'When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.'
nullable: true
lastFullScanDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last quick scan datetime
format: date-time
nullable: true
lastFullScanSignatureVersion:
type: string
description: Last full scan signature version
nullable: true
lastQuickScanDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last quick scan datetime
format: date-time
nullable: true
lastQuickScanSignatureVersion:
type: string
description: Last quick scan signature version
nullable: true
lastReportedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last device health status reported time
format: date-time
nullable: true
malwareProtectionEnabled:
type: boolean
description: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.
nullable: true
networkInspectionSystemEnabled:
type: boolean
description: 'When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.'
nullable: true
productStatus:
$ref: '#/components/schemas/microsoft.graph.windowsDefenderProductStatus'
quickScanOverdue:
type: boolean
description: 'When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.'
nullable: true
realTimeProtectionEnabled:
type: boolean
description: 'When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.'
nullable: true
rebootRequired:
type: boolean
description: 'When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.'
nullable: true
signatureUpdateOverdue:
type: boolean
description: 'When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.'
nullable: true
signatureVersion:
type: string
description: Current malware definitions version
nullable: true
tamperProtectionEnabled:
type: boolean
description: 'When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.'
nullable: true
detectedMalwareState:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
description: Device malware list
x-ms-navigationProperty: true
additionalProperties:
type: object
description: Device protection status entity.
microsoft.graph.followupFlag:
title: followupFlag
type: object
properties:
completedDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
dueDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
flagStatus:
$ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
startDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.inferenceClassificationType:
title: inferenceClassificationType
enum:
- focused
- other
type: string
microsoft.graph.internetMessageHeader:
title: internetMessageHeader
type: object
properties:
name:
type: string
description: Represents the key in a key-value pair.
nullable: true
value:
type: string
description: The value in a key-value pair.
nullable: true
additionalProperties:
type: object
microsoft.graph.notebook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: notebook
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default notebook. Read-only.
nullable: true
isShared:
type: boolean
description: 'Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.'
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.notebookLinks'
sectionGroupsUrl:
type: string
description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.'
nullable: true
sectionsUrl:
type: string
description: 'The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.'
nullable: true
userRole:
$ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenoteOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.operation'
- title: onenoteOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
percentComplete:
type: string
description: The operation percent complete if the operation is still in running status.
nullable: true
resourceId:
type: string
description: The resource id.
nullable: true
resourceLocation:
type: string
description: 'The resource URI for the object. For example, the resource URI for a copied page or section.'
nullable: true
additionalProperties:
type: object
microsoft.graph.onenotePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenotePage
type: object
properties:
content:
type: string
description: The page's HTML content.
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for the page's HTML content. Read-only.
nullable: true
createdByAppId:
type: string
description: The unique identifier of the application that created the page. Read-only.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
level:
maximum: 2147483647
minimum: -2147483648
type: number
description: The indentation level of the page. Read-only.
format: int32
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.pageLinks'
order:
maximum: 2147483647
minimum: -2147483648
type: number
description: The order of the page within its parent section. Read-only.
format: int32
nullable: true
title:
type: string
description: The title of the page.
nullable: true
userTags:
type: array
items:
type: string
nullable: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSection:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
additionalProperties:
type: object
microsoft.graph.onenoteResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteResource
type: object
properties:
content:
type: string
description: The content stream
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for downloading the content
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: sectionGroup
type: object
properties:
sectionGroupsUrl:
type: string
description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.'
nullable: true
sectionsUrl:
type: string
description: 'The URL for the sections navigation property, which returns all the sections in the section group. Read-only.'
nullable: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSectionGroup:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the section. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the section group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenoteSection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: onenoteSection
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default section. Read-only.
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.sectionLinks'
pagesUrl:
type: string
description: The pages endpoint where you can get details for all the pages in the section. Read-only.
nullable: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The collection of pages in the section. Read-only. Nullable.
x-ms-navigationProperty: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSectionGroup:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
additionalProperties:
type: object
microsoft.graph.onlineMeetingBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onlineMeetingBase
type: object
properties:
allowAttendeeToEnableCamera:
type: boolean
description: Indicates whether attendees can turn on their camera.
nullable: true
allowAttendeeToEnableMic:
type: boolean
description: Indicates whether attendees can turn on their microphone.
nullable: true
allowBreakoutRooms:
type: boolean
description: Indicates whether breakout rooms are enabled for the meeting.
nullable: true
allowCopyingAndSharingMeetingContent:
type: boolean
description: Indicates whether the ability to copy and share meeting content is enabled for the meeting.
nullable: true
allowedLobbyAdmitters:
$ref: '#/components/schemas/microsoft.graph.allowedLobbyAdmitterRoles'
allowedPresenters:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingPresenters'
allowLiveShare:
$ref: '#/components/schemas/microsoft.graph.meetingLiveShareOptions'
allowMeetingChat:
$ref: '#/components/schemas/microsoft.graph.meetingChatMode'
allowParticipantsToChangeName:
type: boolean
description: Specifies if participants are allowed to rename themselves in an instance of the meeting.
nullable: true
allowPowerPointSharing:
type: boolean
description: Indicates whether PowerPoint live is enabled for the meeting.
nullable: true
allowRecording:
type: boolean
description: Indicates whether recording is enabled for the meeting.
nullable: true
allowTeamworkReactions:
type: boolean
description: Indicates if Teams reactions are enabled for the meeting.
nullable: true
allowTranscription:
type: boolean
description: Indicates whether transcription is enabled for the meeting.
nullable: true
allowWhiteboard:
type: boolean
description: Indicates whether whiteboard is enabled for the meeting.
nullable: true
audioConferencing:
$ref: '#/components/schemas/microsoft.graph.audioConferencing'
chatInfo:
$ref: '#/components/schemas/microsoft.graph.chatInfo'
chatRestrictions:
$ref: '#/components/schemas/microsoft.graph.chatRestrictions'
cloudVideoInteropInfo:
$ref: '#/components/schemas/microsoft.graph.cloudVideoInteropInfo'
expiryDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Indicates the date and time when the meeting resource expires. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
isEndToEndEncryptionEnabled:
type: boolean
description: Indicates whether end-to-end encryption (E2EE) is enabled for the online meeting.
nullable: true
isEntryExitAnnounced:
type: boolean
description: Indicates whether to announce when callers join or leave.
nullable: true
joinInformation:
$ref: '#/components/schemas/microsoft.graph.itemBody'
joinMeetingIdSettings:
$ref: '#/components/schemas/microsoft.graph.joinMeetingIdSettings'
joinWebUrl:
type: string
description: The join URL of the online meeting. Read-only.
nullable: true
lobbyBypassSettings:
$ref: '#/components/schemas/microsoft.graph.lobbyBypassSettings'
meetingOptionsWebUrl:
type: string
description: Provides the URL to the Teams meeting options page for the specified meeting. This link allows only the organizer to configure meeting settings.
nullable: true
meetingSpokenLanguageTag:
type: string
description: Specifies the spoken language used during the meeting for recording and transcription purposes.
nullable: true
meetingType:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingType'
recordAutomatically:
type: boolean
description: Indicates whether to record the meeting automatically.
nullable: true
sensitivityLabelAssignment:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingSensitivityLabelAssignment'
shareMeetingChatHistoryDefault:
$ref: '#/components/schemas/microsoft.graph.meetingChatHistoryDefaultMode'
subject:
type: string
description: The subject of the online meeting.
nullable: true
videoTeleconferenceId:
type: string
description: The video teleconferencing ID. Read-only.
nullable: true
watermarkProtection:
$ref: '#/components/schemas/microsoft.graph.watermarkProtectionValues'
attendanceReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
description: The attendance reports of an online meeting. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.broadcastMeetingSettings:
title: broadcastMeetingSettings
type: object
properties:
allowedAudience:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingAudience'
captions:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingCaptionSettings'
isAttendeeReportEnabled:
type: boolean
description: Indicates whether attendee report is enabled for this Teams live event. Default value is false.
nullable: true
isQuestionAndAnswerEnabled:
type: boolean
description: Indicates whether Q&A is enabled for this Teams live event. Default value is false.
nullable: true
isRecordingEnabled:
type: boolean
description: Indicates whether recording is enabled for this Teams live event. Default value is false.
nullable: true
isVideoOnDemandEnabled:
type: boolean
description: Indicates whether video on demand is enabled for this Teams live event. Default value is false.
nullable: true
additionalProperties:
type: object
microsoft.graph.meetingParticipants:
title: meetingParticipants
type: object
properties:
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
description: Information about the meeting attendees.
organizer:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
additionalProperties:
type: object
microsoft.graph.outlookCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookCategory
type: object
properties:
color:
$ref: '#/components/schemas/microsoft.graph.categoryColor'
displayName:
type: string
description: 'A unique name that identifies a category in the user''s mailbox. After a category is created, the name cannot be changed. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.personType:
title: personType
type: object
properties:
class:
type: string
description: 'The type of data source, such as Person.'
nullable: true
subclass:
type: string
description: 'The secondary type of data source, such as OrganizationUser.'
nullable: true
additionalProperties:
type: object
microsoft.graph.phone:
title: phone
type: object
properties:
language:
type: string
nullable: true
number:
type: string
description: The phone number.
nullable: true
region:
type: string
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.phoneType'
additionalProperties:
type: object
microsoft.graph.scoredEmailAddress:
title: scoredEmailAddress
type: object
properties:
address:
type: string
description: The email address.
nullable: true
itemId:
type: string
nullable: true
relevanceScore:
type: number
description: 'The relevance score of the email address. A relevance score is used as a sort key, in relation to the other returned results. A higher relevance score value corresponds to a more relevant result. Relevance is determined by the user’s communication and collaboration patterns and business relationships.'
format: double
nullable: true
selectionLikelihood:
$ref: '#/components/schemas/microsoft.graph.selectionLikelihoodInfo'
additionalProperties:
type: object
microsoft.graph.website:
title: website
type: object
properties:
address:
type: string
description: The URL of the website.
nullable: true
displayName:
type: string
description: The display name of the web site.
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.websiteType'
additionalProperties:
type: object
microsoft.graph.plannerPlan:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlan
type: object
properties:
container:
$ref: '#/components/schemas/microsoft.graph.plannerPlanContainer'
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
owner:
type: string
description: 'Use the container property instead. ID of the group that owns the plan. After it''s set, this property can’t be updated. This property won''t return a valid group ID if the container of the plan isn''t a group.'
nullable: true
title:
type: string
description: Required. Title of the plan.
buckets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
description: Read-only. Nullable. Collection of buckets in the plan.
x-ms-navigationProperty: true
details:
$ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Collection of tasks in the plan.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.plannerTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTask
type: object
properties:
activeChecklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Number of checklist items with value set to false, representing incomplete items.'
format: int32
nullable: true
appliedCategories:
$ref: '#/components/schemas/microsoft.graph.plannerAppliedCategories'
assigneePriority:
type: string
description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
assignments:
$ref: '#/components/schemas/microsoft.graph.plannerAssignments'
bucketId:
type: string
description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
nullable: true
checklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of checklist items that are present on the task.
format: int32
nullable: true
completedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read-only. Date and time at which the ''percentComplete'' of the task is set to ''100''. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
conversationThreadId:
type: string
description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
dueDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
hasDescription:
type: boolean
description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
nullable: true
orderHint:
type: string
description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
percentComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Percentage of task completion. When set to 100, the task is considered completed.'
format: int32
nullable: true
planId:
type: string
description: Plan ID to which the task belongs.
nullable: true
previewType:
$ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
priority:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ''urgent'', 2, 3 and 4 as ''important'', 5, 6, and 7 as ''medium'', and 8, 9, and 10 as ''low''. Additionally, Planner sets the value 1 for ''urgent'', 3 for ''important'', 5 for ''medium'', and 9 for ''low''.'
format: int32
nullable: true
referenceCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of external references that exist on the task.
format: int32
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
title:
type: string
description: Title of the task.
assignedToTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat'
bucketTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat'
details:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
progressTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat'
additionalProperties:
type: object
microsoft.graph.outOfOfficeSettings:
title: outOfOfficeSettings
type: object
properties:
isOutOfOffice:
type: boolean
description: 'If true, either of the following is met:The current time falls within the out-of-office window configured in Outlook or Teams.An event marked as ''Show as Out of Office'' appears on the user''s calendar.Otherwise, false.'
nullable: true
message:
type: string
description: The out-of-office message configured by the user in the Outlook client (Automatic replies) or the Teams client (Schedule out of office).
nullable: true
additionalProperties:
type: object
microsoft.graph.presenceStatusMessage:
title: presenceStatusMessage
type: object
properties:
expiryDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
message:
$ref: '#/components/schemas/microsoft.graph.itemBody'
publishedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.userWorkLocation:
title: userWorkLocation
type: object
properties:
placeId:
type: string
description: 'Identifier of the place, if applicable.'
nullable: true
source:
$ref: '#/components/schemas/microsoft.graph.workLocationSource'
workLocationType:
$ref: '#/components/schemas/microsoft.graph.workLocationType'
additionalProperties:
type: object
microsoft.graph.exchangeSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: exchangeSettings
type: object
properties:
primaryMailboxId:
type: string
description: The unique identifier for the user's primary mailbox.
nullable: true
additionalProperties:
type: object
microsoft.graph.userInsightsSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userInsightsSettings
type: object
properties:
isEnabled:
type: boolean
description: True if the user's itemInsights and meeting hours insights are enabled; false if the user's itemInsights and meeting hours insights are disabled. The default value is true. Optional.
additionalProperties:
type: object
microsoft.graph.shiftPreferences:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: shiftPreferences
type: object
properties:
availability:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shiftAvailability'
description: Availability of the user to be scheduled for work and its recurrence pattern.
additionalProperties:
type: object
microsoft.graph.userStorage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userStorage
type: object
properties:
quota:
$ref: '#/components/schemas/microsoft.graph.unifiedStorageQuota'
additionalProperties:
type: object
microsoft.graph.windowsSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsSetting
type: object
properties:
payloadType:
type: string
description: The type of setting payloads contained in the instances navigation property.
nullable: true
settingType:
$ref: '#/components/schemas/microsoft.graph.windowsSettingType'
windowsDeviceId:
type: string
description: A unique identifier for the device the setting might belong to if it is of the settingType backup.
nullable: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
description: A collection of setting values for a given windowsSetting.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workHoursAndLocationsSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workHoursAndLocationsSetting
type: object
properties:
maxSharedWorkLocationDetails:
$ref: '#/components/schemas/microsoft.graph.maxWorkLocationDetails'
occurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workPlanOccurrence'
description: Collection of work plan occurrences.
x-ms-navigationProperty: true
recurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workPlanRecurrence'
description: Collection of recurring work plans defined by the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workingTimeSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workingTimeSchedule
type: object
additionalProperties:
type: object
microsoft.graph.associatedTeamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamInfo'
- title: associatedTeamInfo
type: object
additionalProperties:
type: object
microsoft.graph.userScopeTeamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
- title: userScopeTeamsAppInstallation
type: object
properties:
chat:
$ref: '#/components/schemas/microsoft.graph.chat'
additionalProperties:
type: object
microsoft.graph.todoTaskList:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todoTaskList
type: object
properties:
displayName:
type: string
description: The name of the task list.
nullable: true
isOwner:
type: boolean
description: True if the user is owner of the given task list.
isShared:
type: boolean
description: True if the task list is shared with other users
wellknownListName:
$ref: '#/components/schemas/microsoft.graph.wellknownListName'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the task list. Nullable.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTask'
description: The tasks in this task list. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.externalAudienceScope:
title: externalAudienceScope
enum:
- none
- contactsOnly
- all
type: string
microsoft.graph.automaticRepliesStatus:
title: automaticRepliesStatus
enum:
- disabled
- alwaysEnabled
- scheduled
type: string
microsoft.graph.dayOfWeek:
title: dayOfWeek
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
type: string
microsoft.graph.timeZoneBase:
title: timeZoneBase
type: object
properties:
name:
type: string
description: 'The name of a time zone. It can be a standard time zone name such as ''Hawaii-Aleutian Standard Time'', or ''Customized Time Zone'' for a custom time zone.'
nullable: true
additionalProperties:
type: object
microsoft.graph.identityGovernance.quarantineType:
title: quarantineType
enum:
- notQuarantined
- countBasedThresholdExceeded
- percentageBasedThresholdExceeded
- multipleConditionsExceeded
- unknownFutureValue
type: string
microsoft.graph.identityGovernance.valueType:
title: valueType
enum:
- enum
- string
- int
- bool
- unknownFutureValue
type: string
microsoft.graph.identityGovernance.quarantineCondition:
title: quarantineCondition
type: object
additionalProperties:
type: object
microsoft.graph.identityGovernance.matchMode:
title: matchMode
enum:
- any
- all
- unknownFutureValue
type: string
microsoft.graph.settingValue:
title: settingValue
type: object
properties:
name:
type: string
description: Name of the setting (as defined by the groupSettingTemplate).
nullable: true
value:
type: string
description: Value of the setting.
nullable: true
additionalProperties:
type: object
microsoft.graph.post:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: post
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
conversationId:
type: string
description: Unique ID of the conversation. Read-only.
nullable: true
conversationThreadId:
type: string
description: Unique ID of the conversation thread. Read-only.
nullable: true
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: Indicates whether the post has at least one attachment. This is a default property.
newParticipants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Conversation participants that were added to the thread as part of this post.
receivedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Specifies when the post was received. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
inReplyTo:
$ref: '#/components/schemas/microsoft.graph.post'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the post. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the post. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.scheduleRequestActions:
title: scheduleRequestActions
enum:
- adminAssign
- adminUpdate
- adminRemove
- selfActivate
- selfDeactivate
- adminExtend
- adminRenew
- selfExtend
- selfRenew
- unknownFutureValue
type: string
microsoft.graph.ODataErrors.MainError:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
x-ms-primary-error-message: true
target:
type: string
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
innerError:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
additionalProperties:
type: object
microsoft.graph.recurrencePattern:
title: recurrencePattern
type: object
properties:
dayOfMonth:
maximum: 2147483647
minimum: -2147483648
type: number
description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.
format: int32
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: 'A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.'
firstDayOfWeek:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
index:
$ref: '#/components/schemas/microsoft.graph.weekIndex'
interval:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.'
format: int32
month:
maximum: 2147483647
minimum: -2147483648
type: number
description: The month in which the event occurs. This is a number from 1 to 12.
format: int32
type:
$ref: '#/components/schemas/microsoft.graph.recurrencePatternType'
additionalProperties:
type: object
microsoft.graph.recurrenceRange:
title: recurrenceRange
type: object
properties:
endDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.'
format: date
nullable: true
numberOfOccurrences:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of times to repeat the event. Required and must be positive if type is numbered.
format: int32
recurrenceTimeZone:
type: string
description: 'Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.'
nullable: true
startDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.'
format: date
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.recurrenceRangeType'
additionalProperties:
type: object
microsoft.graph.approverInformationVisibility:
title: approverInformationVisibility
enum:
- default
- notVisible
- visible
- unknownFutureValue
type: string
microsoft.graph.printerBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: printerBase
type: object
properties:
capabilities:
$ref: '#/components/schemas/microsoft.graph.printerCapabilities'
defaults:
$ref: '#/components/schemas/microsoft.graph.printerDefaults'
displayName:
type: string
description: The name of the printer/printerShare.
isAcceptingJobs:
type: boolean
description: Specifies whether the printer/printerShare is currently accepting new print jobs.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.printerLocation'
manufacturer:
type: string
description: The manufacturer of the printer/printerShare.
nullable: true
model:
type: string
description: The model name of the printer/printerShare.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.printerStatus'
jobs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printJob'
description: The list of jobs that are queued for printing by the printer/printerShare.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.printerShareViewpoint:
title: printerShareViewpoint
type: object
properties:
lastUsedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time when the printer was last used by the signed-in user. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.printer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.printerBase'
- title: printer
type: object
properties:
hasPhysicalDevice:
type: boolean
description: True if the printer has a physical device for printing. Read-only.
isShared:
type: boolean
description: True if the printer is shared; false otherwise. Read-only.
lastSeenDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.
format: date-time
nullable: true
registeredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTimeOffset when the printer was registered. Read-only.
format: date-time
connectors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printConnector'
description: The connectors that are associated with the printer.
x-ms-navigationProperty: true
shares:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printerShare'
description: 'The list of printerShares that are associated with the printer. Currently, only one printerShare can be associated with the printer. Read-only. Nullable.'
x-ms-navigationProperty: true
taskTriggers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printTaskTrigger'
description: A list of task triggers that are associated with the printer.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.imageInfo:
title: imageInfo
type: object
properties:
addImageQuery:
type: boolean
description: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example – a high contrast image
nullable: true
alternateText:
type: string
description: Optional; alt-text accessible content for the image
nullable: true
alternativeText:
type: string
nullable: true
iconUrl:
type: string
description: Optional; URI that points to an icon which represents the application used to generate the activity
nullable: true
additionalProperties:
type: object
microsoft.graph.attestationLevel:
title: attestationLevel
enum:
- attested
- notAttested
- unknownFutureValue
type: string
microsoft.graph.passkeyType:
title: passkeyType
enum:
- deviceBound
- synced
- unknownFutureValue
type: string
microsoft.graph.webauthnPublicKeyCredential:
title: webauthnPublicKeyCredential
type: object
properties:
clientExtensionResults:
$ref: '#/components/schemas/microsoft.graph.webauthnAuthenticationExtensionsClientOutputs'
id:
type: string
description: The credential ID created by the WebAuthn Authenticator. This value is Base64URL-encoded without padding.
nullable: true
response:
$ref: '#/components/schemas/microsoft.graph.webauthnAuthenticatorAttestationResponse'
additionalProperties:
type: object
microsoft.graph.device:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: device
type: object
properties:
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.'
nullable: true
alternativeSecurityIds:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le).'
approximateLastSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.'
format: date-time
nullable: true
complianceExpirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
deviceCategory:
type: string
description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
nullable: true
deviceId:
type: string
description: 'Unique identifier set by Azure Device Registration Service at the time of registration. This alternate key can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).'
nullable: true
deviceMetadata:
type: string
description: For internal use only. Set to null.
nullable: true
deviceOwnership:
type: string
description: 'Ownership of the device. Intune sets this property. The possible values are: unknown, company, personal.'
nullable: true
deviceVersion:
maximum: 2147483647
minimum: -2147483648
type: number
description: For internal use only.
format: int32
nullable: true
displayName:
type: string
description: 'The display name for the device. Maximum length is 256 characters. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
enrollmentProfileName:
type: string
description: 'Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.'
nullable: true
enrollmentType:
type: string
description: 'Enrollment type of the device. Intune sets this property. The possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.'
nullable: true
isCompliant:
type: boolean
description: 'true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).'
nullable: true
isManaged:
type: boolean
description: 'true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).'
nullable: true
isManagementRestricted:
type: boolean
description: 'Indicates whether the device is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a device that''s a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve.'
nullable: true
isRooted:
type: boolean
description: true if the device is rooted or jail-broken. This property can only be updated by Intune.
nullable: true
managementType:
type: string
description: 'The management channel of the device. This property is set by Intune. The possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.'
nullable: true
manufacturer:
type: string
description: Manufacturer of the device. Read-only.
nullable: true
mdmAppId:
type: string
description: 'Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).'
nullable: true
model:
type: string
description: Model of the device. Read-only.
nullable: true
onPremisesLastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesSecurityIdentifier:
type: string
description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Requires $select to retrieve. Supports $filter (eq).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
operatingSystem:
type: string
description: 'The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
operatingSystemVersion:
type: string
description: 'The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
physicalIds:
type: array
items:
type: string
description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).'
profileType:
type: string
description: 'The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.'
nullable: true
registrationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
systemLabels:
type: array
items:
type: string
description: 'List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).'
trustType:
type: string
description: 'Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud-only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID. Supports $filter (eq, ne, not, in).'
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the device. Read-only. Nullable.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredOwners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Groups and administrative units that the device is a member of. This operation is transitive. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.longRunningOperationStatus:
title: longRunningOperationStatus
enum:
- notStarted
- running
- succeeded
- failed
- unknownFutureValue
type: string
microsoft.graph.authenticationPhoneType:
title: authenticationPhoneType
enum:
- mobile
- alternateMobile
- office
- unknownFutureValue
type: string
microsoft.graph.authenticationMethodSignInState:
title: authenticationMethodSignInState
enum:
- notSupported
- notAllowedByPolicy
- notEnabled
- phoneNumberNotUnique
- ready
- notConfigured
- unknownFutureValue
type: string
microsoft.graph.authenticationMethodKeyStrength:
title: authenticationMethodKeyStrength
enum:
- normal
- weak
- unknown
type: string
microsoft.graph.authenticationMethodPlatform:
title: authenticationMethodPlatform
enum:
- unknown
- windows
- macOS
- iOS
- android
- linux
- unknownFutureValue
type: string
microsoft.graph.calendarRoleType:
title: calendarRoleType
enum:
- none
- freeBusyRead
- limitedRead
- read
- write
- delegateWithoutPrivateEventAccess
- delegateWithPrivateEventAccess
- custom
type: string
microsoft.graph.attendeeBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- title: attendeeBase
type: object
properties:
type:
$ref: '#/components/schemas/microsoft.graph.attendeeType'
additionalProperties:
type: object
microsoft.graph.timeSlot:
title: timeSlot
type: object
properties:
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.bodyType:
title: bodyType
enum:
- text
- html
type: string
microsoft.graph.outlookGeoCoordinates:
title: outlookGeoCoordinates
type: object
properties:
accuracy:
type: number
description: 'The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.'
format: double
nullable: true
altitude:
type: number
description: The altitude of the location.
format: double
nullable: true
altitudeAccuracy:
type: number
description: The accuracy of the altitude.
format: double
nullable: true
latitude:
type: number
description: The latitude of the location.
format: double
nullable: true
longitude:
type: number
description: The longitude of the location.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.locationType:
title: locationType
enum:
- default
- conferenceRoom
- homeAddress
- businessAddress
- geoCoordinates
- streetAddress
- hotel
- restaurant
- localBusiness
- postalAddress
type: string
microsoft.graph.locationUniqueIdType:
title: locationUniqueIdType
enum:
- unknown
- locationStore
- directory
- private
- bing
type: string
microsoft.graph.responseType:
title: responseType
enum:
- none
- organizer
- tentativelyAccepted
- accepted
- declined
- notResponded
type: string
microsoft.graph.teamworkUserIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: teamworkUserIdentity
type: object
properties:
userIdentityType:
$ref: '#/components/schemas/microsoft.graph.teamworkUserIdentityType'
additionalProperties:
type: object
microsoft.graph.teamsAppPermissionSet:
title: teamsAppPermissionSet
type: object
properties:
resourceSpecificPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppResourceSpecificPermission'
description: A collection of resource-specific permissions.
additionalProperties:
type: object
microsoft.graph.teamsApp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsApp
type: object
properties:
displayName:
type: string
description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
nullable: true
distributionMethod:
$ref: '#/components/schemas/microsoft.graph.teamsAppDistributionMethod'
externalId:
type: string
description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
nullable: true
appDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
description: The details for each version of the app.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsAppDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppDefinition
type: object
properties:
authorization:
$ref: '#/components/schemas/microsoft.graph.teamsAppAuthorization'
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
description:
type: string
description: Verbose description of the application.
nullable: true
displayName:
type: string
description: The name of the app provided by the app developer.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
publishingState:
$ref: '#/components/schemas/microsoft.graph.teamsAppPublishingState'
shortDescription:
type: string
description: Short description of the application.
nullable: true
teamsAppId:
type: string
description: The ID from the Teams app manifest.
nullable: true
version:
type: string
description: The version number of the application.
nullable: true
bot:
$ref: '#/components/schemas/microsoft.graph.teamworkBot'
additionalProperties:
type: object
microsoft.graph.eventMessageDetail:
title: eventMessageDetail
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageFromIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: chatMessageFromIdentitySet
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageType:
title: chatMessageType
enum:
- message
- chatEvent
- typing
- unknownFutureValue
- systemEventMessage
type: string
microsoft.graph.chatMessageAttachment:
title: chatMessageAttachment
type: object
properties:
content:
type: string
description: 'The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.'
nullable: true
contentType:
type: string
description: 'The media type of the content attachment. The possible values are: reference: The attachment is a link to another file. Populate the contentURL with the link to the object.forwardedMessageReference: The attachment is a reference to a forwarded message. Populate the content with the original message context.Any contentType that is supported by the Bot Framework''s Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.'
nullable: true
contentUrl:
type: string
description: The URL for the content of the attachment.
nullable: true
id:
type: string
description: Read-only. The unique ID of the attachment.
nullable: true
name:
type: string
description: The name of the attachment.
nullable: true
teamsAppId:
type: string
description: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.
nullable: true
thumbnailUrl:
type: string
description: 'The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.'
nullable: true
additionalProperties:
type: object
microsoft.graph.channelIdentity:
title: channelIdentity
type: object
properties:
channelId:
type: string
description: The identity of the channel in which the message was posted.
nullable: true
teamId:
type: string
description: The identity of the team in which the message was posted.
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageImportance:
title: chatMessageImportance
enum:
- normal
- high
- urgent
- unknownFutureValue
type: string
microsoft.graph.chatMessageMention:
title: chatMessageMention
type: object
properties:
id:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.'
format: int32
nullable: true
mentioned:
$ref: '#/components/schemas/microsoft.graph.chatMessageMentionedIdentitySet'
mentionText:
type: string
description: 'String used to represent the mention. For example, a user''s display name, a team name.'
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageHistoryItem:
title: chatMessageHistoryItem
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.chatMessageActions'
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the message was modified.
format: date-time
reaction:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
additionalProperties:
type: object
microsoft.graph.chatMessagePolicyViolation:
title: chatMessagePolicyViolation
type: object
properties:
dlpAction:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationDlpActionTypes'
justificationText:
type: string
description: Justification text provided by the sender of the message when overriding a policy violation.
nullable: true
policyTip:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationPolicyTip'
userAction:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationUserActionTypes'
verdictDetails:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationVerdictDetailsTypes'
additionalProperties:
type: object
microsoft.graph.chatMessageReaction:
title: chatMessageReaction
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
displayName:
type: string
description: The name of the reaction.
nullable: true
reactionContentUrl:
type: string
description: The hosted content URL for the custom reaction type.
nullable: true
reactionType:
type: string
description: 'The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.'
user:
$ref: '#/components/schemas/microsoft.graph.chatMessageReactionIdentitySet'
additionalProperties:
type: object
microsoft.graph.chatMessageHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamworkHostedContent'
- title: chatMessageHostedContent
type: object
additionalProperties:
type: object
microsoft.graph.teamsTabConfiguration:
title: teamsTabConfiguration
type: object
properties:
contentUrl:
type: string
description: Url used for rendering tab contents in Teams. Required.
nullable: true
entityId:
type: string
description: Identifier for the entity hosted by the tab provider.
nullable: true
removeUrl:
type: string
description: Url called by Teams client when a Tab is removed using the Teams Client.
nullable: true
websiteUrl:
type: string
description: Url for showing tab contents outside of Teams.
nullable: true
additionalProperties:
type: object
microsoft.graph.cloudClipboardItemPayload:
title: cloudClipboardItemPayload
type: object
properties:
content:
type: string
description: The formatName version of the value of a cloud clipboard encoded in base64.
formatName:
type: string
description: For a list of possible values see formatName values.
additionalProperties:
type: object
microsoft.graph.sensitivityLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: sensitivityLabel
type: object
properties:
actionSource:
$ref: '#/components/schemas/microsoft.graph.labelActionSource'
autoTooltip:
type: string
nullable: true
description:
type: string
nullable: true
displayName:
type: string
nullable: true
hasProtection:
type: boolean
nullable: true
isDefault:
type: boolean
nullable: true
isEndpointProtectionEnabled:
type: boolean
nullable: true
isScopedToUser:
type: boolean
nullable: true
locale:
type: string
nullable: true
name:
type: string
nullable: true
priority:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
toolTip:
type: string
nullable: true
rights:
$ref: '#/components/schemas/microsoft.graph.usageRightsIncluded'
sublabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.contentActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentActivity
type: object
properties:
contentMetadata:
$ref: '#/components/schemas/microsoft.graph.processContentRequest'
scopeIdentifier:
type: string
description: The scope identified from computed protection scopes.
nullable: true
userId:
type: string
description: ID of the user.
nullable: true
additionalProperties:
type: object
microsoft.graph.itemReference:
title: itemReference
type: object
properties:
driveId:
type: string
description: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only.
nullable: true
driveType:
type: string
description: Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values.
nullable: true
id:
type: string
description: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
nullable: true
name:
type: string
description: The name of the item being referenced. Read-only.
nullable: true
path:
type: string
description: Percent-encoded path that can be used to navigate to the item. Read-only.
nullable: true
shareId:
type: string
description: A unique identifier for a shared resource that can be accessed via the Shares API.
nullable: true
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteId:
type: string
description: 'For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that site resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.'
nullable: true
additionalProperties:
type: object
microsoft.graph.storagePlanInformation:
title: storagePlanInformation
type: object
properties:
upgradeAvailable:
type: boolean
description: Indicates whether there are higher storage quota plans available. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.audio:
title: audio
type: object
properties:
album:
type: string
description: The title of the album for this audio file.
nullable: true
albumArtist:
type: string
description: The artist named on the album for the audio file.
nullable: true
artist:
type: string
description: The performing artist for the audio file.
nullable: true
bitrate:
type: number
description: Bitrate expressed in kbps.
format: int64
nullable: true
composers:
type: string
description: The name of the composer of the audio file.
nullable: true
copyright:
type: string
description: Copyright information for the audio file.
nullable: true
disc:
maximum: 32767
minimum: -32768
type: number
description: The number of the disc this audio file came from.
format: int16
nullable: true
discCount:
maximum: 32767
minimum: -32768
type: number
description: The total number of discs in this album.
format: int16
nullable: true
duration:
type: number
description: 'Duration of the audio file, expressed in milliseconds'
format: int64
nullable: true
genre:
type: string
description: The genre of this audio file.
nullable: true
hasDrm:
type: boolean
description: Indicates if the file is protected with digital rights management.
nullable: true
isVariableBitrate:
type: boolean
description: Indicates if the file is encoded with a variable bitrate.
nullable: true
title:
type: string
description: The title of the audio file.
nullable: true
track:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of the track on the original disc for this audio file.
format: int32
nullable: true
trackCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of tracks on the original disc for this audio file.
format: int32
nullable: true
year:
maximum: 2147483647
minimum: -2147483648
type: number
description: The year the audio file was recorded.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.bundle:
title: bundle
type: object
properties:
album:
$ref: '#/components/schemas/microsoft.graph.album'
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.deleted:
title: deleted
type: object
properties:
state:
type: string
description: Represents the state of the deleted item.
nullable: true
additionalProperties:
type: object
microsoft.graph.file:
title: file
type: object
properties:
hashes:
$ref: '#/components/schemas/microsoft.graph.hashes'
mimeType:
type: string
description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only.
nullable: true
processingMetadata:
type: boolean
nullable: true
additionalProperties:
type: object
microsoft.graph.fileSystemInfo:
title: fileSystemInfo
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time the file was created on a client.
format: date-time
nullable: true
lastAccessedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time the file was last accessed. Available for the recent file list only.
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time the file was last modified on a client.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.folder:
title: folder
type: object
properties:
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
view:
$ref: '#/components/schemas/microsoft.graph.folderView'
additionalProperties:
type: object
microsoft.graph.image:
title: image
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. Height of the image, in pixels. Read-only.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. Width of the image, in pixels. Read-only.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.geoCoordinates:
title: geoCoordinates
type: object
properties:
altitude:
type: number
description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.'
format: double
nullable: true
latitude:
type: number
description: 'Optional. The latitude, in decimal, for the item. Read-only.'
format: double
nullable: true
longitude:
type: number
description: 'Optional. The longitude, in decimal, for the item. Read-only.'
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.malware:
title: malware
type: object
properties:
description:
type: string
description: Contains the virus details for the malware facet.
nullable: true
additionalProperties:
type: object
microsoft.graph.package:
title: package
type: object
properties:
type:
type: string
description: 'A string indicating the type of package. While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.'
nullable: true
additionalProperties:
type: object
microsoft.graph.pendingOperations:
title: pendingOperations
type: object
properties:
pendingContentUpdate:
$ref: '#/components/schemas/microsoft.graph.pendingContentUpdate'
additionalProperties:
type: object
microsoft.graph.photo:
title: photo
type: object
properties:
cameraMake:
type: string
description: Camera manufacturer. Read-only.
nullable: true
cameraModel:
type: string
description: Camera model. Read-only.
nullable: true
exposureDenominator:
type: number
description: The denominator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
exposureNumerator:
type: number
description: The numerator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
fNumber:
type: number
description: The F-stop value from the camera. Read-only.
format: double
nullable: true
focalLength:
type: number
description: The focal length from the camera. Read-only.
format: double
nullable: true
iso:
maximum: 2147483647
minimum: -2147483648
type: number
description: The ISO value from the camera. Read-only.
format: int32
nullable: true
orientation:
maximum: 32767
minimum: -32768
type: number
description: The orientation value from the camera. Writable on OneDrive Personal.
format: int16
nullable: true
takenDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Represents the date and time the photo was taken. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.publicationFacet:
title: publicationFacet
type: object
properties:
checkedOutBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
level:
type: string
description: The state of publication for this document. Either published or checkout. Read-only.
nullable: true
versionId:
type: string
description: The unique identifier for the version that is visible to the current caller. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.remoteItem:
title: remoteItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of item creation. Read-only.
format: date-time
nullable: true
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
id:
type: string
description: Unique identifier for the remote item in its drive. Read-only.
nullable: true
image:
$ref: '#/components/schemas/microsoft.graph.image'
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time the item was last modified. Read-only.
format: date-time
nullable: true
name:
type: string
description: Optional. Filename of the remote item. Read-only.
nullable: true
package:
$ref: '#/components/schemas/microsoft.graph.package'
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: number
description: Size of the remote item. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: DAV compatible URL for the item.
nullable: true
webUrl:
type: string
description: URL that displays the resource in the browser. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.searchResult:
title: searchResult
type: object
properties:
onClickTelemetryUrl:
type: string
description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results.
nullable: true
additionalProperties:
type: object
microsoft.graph.shared:
title: shared
type: object
properties:
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
scope:
type: string
description: 'Indicates the scope of how the item is shared. The possible values are: anonymous, organization, or users. Read-only.'
nullable: true
sharedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
sharedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time when the item was shared. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.specialFolder:
title: specialFolder
type: object
properties:
name:
type: string
description: The unique identifier for this item in the /drive/special collection
nullable: true
additionalProperties:
type: object
microsoft.graph.video:
title: video
type: object
properties:
audioBitsPerSample:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio bits per sample.
format: int32
nullable: true
audioChannels:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio channels.
format: int32
nullable: true
audioFormat:
type: string
description: 'Name of the audio format (AAC, MP3, etc.).'
nullable: true
audioSamplesPerSecond:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio samples per second.
format: int32
nullable: true
bitrate:
maximum: 2147483647
minimum: -2147483648
type: number
description: Bit rate of the video in bits per second.
format: int32
nullable: true
duration:
type: number
description: Duration of the file in milliseconds.
format: int64
nullable: true
fourCC:
type: string
description: '''Four character code'' name of the video format.'
nullable: true
frameRate:
type: number
description: Frame rate of the video.
format: double
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Height of the video, in pixels.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Width of the video, in pixels.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.listItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: listItem
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
deleted:
$ref: '#/components/schemas/microsoft.graph.deleted'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
documentSetVersions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetVersion'
description: Version information for a document set version created by a user.
x-ms-navigationProperty: true
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
fields:
$ref: '#/components/schemas/microsoft.graph.fieldValueSet'
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItemVersion'
description: The list of previous versions of the list item.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.itemRetentionLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemRetentionLabel
type: object
properties:
isLabelAppliedExplicitly:
type: boolean
description: 'Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only.'
nullable: true
labelAppliedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
labelAppliedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the label was applied on the item. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
name:
type: string
description: The retention label on the document. Read-write.
nullable: true
retentionSettings:
$ref: '#/components/schemas/microsoft.graph.retentionLabelSettings'
additionalProperties:
type: object
microsoft.graph.subscription:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: subscription
type: object
properties:
applicationId:
type: string
description: Optional. Identifier of the application used to create the subscription. Read-only.
nullable: true
changeType:
type: string
description: 'Required. Indicates the type of change in the subscribed resource that raises a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated, or soft deleted. Use deleted to receive notifications when user or group is permanently deleted.'
clientState:
type: string
description: Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
nullable: true
creatorId:
type: string
description: 'Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only.'
nullable: true
encryptionCertificate:
type: string
description: Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true.
nullable: true
encryptionCertificateId:
type: string
description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time. For the maximum supported subscription length of time, see Subscription lifetime.'
format: date-time
includeResourceData:
type: boolean
description: 'Optional. When set to true, change notifications include resource data (such as content of a chat message).'
nullable: true
latestSupportedTlsVersion:
type: string
description: 'Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v10, v11, v12, v13. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.'
nullable: true
lifecycleNotificationUrl:
type: string
description: 'Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications.'
nullable: true
notificationQueryOptions:
type: string
description: 'Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.'
nullable: true
notificationUrl:
type: string
description: Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.
notificationUrlAppId:
type: string
description: Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
nullable: true
resource:
type: string
description: Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.
additionalProperties:
type: object
microsoft.graph.thumbnailSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: thumbnailSet
type: object
properties:
large:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
medium:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
small:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
source:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
additionalProperties:
type: object
microsoft.graph.driveItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- title: driveItemVersion
type: object
properties:
content:
type: string
description: The content stream for this version of the item.
format: base64url
nullable: true
size:
type: number
description: Indicates the size of the content stream for this version of the item.
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.workbook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbook
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.workbookApplication'
comments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookComment'
description: Represents a collection of comments in a workbook.
x-ms-navigationProperty: true
functions:
$ref: '#/components/schemas/microsoft.graph.workbookFunctions'
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookOperation'
description: 'The status of workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the Location header is returned in the response. Read-only.'
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: Represents a collection of tables associated with the workbook. Read-only.
x-ms-navigationProperty: true
worksheets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
description: Represents a collection of worksheets associated with the workbook. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.listInfo:
title: listInfo
type: object
properties:
contentTypesEnabled:
type: boolean
description: 'If true, indicates that content types are enabled for this list.'
nullable: true
hidden:
type: boolean
description: 'If true, indicates that the list isn''t normally visible in the SharePoint user experience.'
nullable: true
template:
type: string
description: 'An enumerated value that represents the base list template used in creating the list. Possible values include documentLibrary, genericList, task, survey, announcements, contacts, and more.'
nullable: true
additionalProperties:
type: object
microsoft.graph.engagementRoleMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: engagementRoleMember
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the role was assigned to the user. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
readOnly: true
userId:
type: string
description: The Microsoft Entra ID of the user who has the role assigned.
nullable: true
readOnly: true
user:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
description: Entity to represent the assignment of a role to a user.
microsoft.graph.courseStatus:
title: courseStatus
enum:
- notStarted
- inProgress
- completed
- unknownFutureValue
type: string
microsoft.graph.publicErrorDetail:
title: publicErrorDetail
type: object
properties:
code:
type: string
description: The error code.
nullable: true
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.publicInnerError:
title: publicInnerError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
description: A collection of error details.
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.siteArchivalDetails:
title: siteArchivalDetails
type: object
properties:
archiveStatus:
$ref: '#/components/schemas/microsoft.graph.siteArchiveStatus'
additionalProperties:
type: object
microsoft.graph.itemActivityStat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemActivityStat
type: object
properties:
access:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
create:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
delete:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
edit:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the interval ends. Read-only.
format: date-time
nullable: true
incompleteData:
$ref: '#/components/schemas/microsoft.graph.incompleteData'
isTrending:
type: boolean
description: Indicates whether the item is 'trending.' Read-only.
nullable: true
move:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the interval starts. Read-only.
format: date-time
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivity'
description: Exposes the itemActivities represented in this itemActivityStat resource.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.booleanColumn:
title: booleanColumn
type: object
additionalProperties:
type: object
microsoft.graph.calculatedColumn:
title: calculatedColumn
type: object
properties:
format:
type: string
description: 'For dateTime output types, the format of the value. The possible values are: dateOnly or dateTime.'
nullable: true
formula:
type: string
description: The formula used to compute the value for this column.
nullable: true
outputType:
type: string
description: 'The output type used to format values in this column. The possible values are: boolean, currency, dateTime, number, or text.'
nullable: true
additionalProperties:
type: object
microsoft.graph.choiceColumn:
title: choiceColumn
type: object
properties:
allowTextEntry:
type: boolean
description: 'If true, allows custom values that aren''t in the configured choices.'
nullable: true
choices:
type: array
items:
type: string
nullable: true
description: The list of values available for this column.
displayAs:
type: string
description: 'How the choices are to be presented in the UX. Must be one of checkBoxes, dropDownMenu, or radioButtons'
nullable: true
additionalProperties:
type: object
microsoft.graph.contentApprovalStatusColumn:
title: contentApprovalStatusColumn
type: object
additionalProperties:
type: object
microsoft.graph.currencyColumn:
title: currencyColumn
type: object
properties:
locale:
type: string
description: Specifies the locale from which to infer the currency symbol.
nullable: true
additionalProperties:
type: object
microsoft.graph.dateTimeColumn:
title: dateTimeColumn
type: object
properties:
displayAs:
type: string
description: 'How the value should be presented in the UX. Must be one of default, friendly, or standard. See below for more details. If unspecified, treated as default.'
nullable: true
format:
type: string
description: Indicates whether the value should be presented as a date only or a date and time. Must be one of dateOnly or dateTime
nullable: true
additionalProperties:
type: object
microsoft.graph.defaultColumnValue:
title: defaultColumnValue
type: object
properties:
formula:
type: string
description: The formula used to compute the default value for the column.
nullable: true
value:
type: string
description: The direct value to use as the default value for the column.
nullable: true
additionalProperties:
type: object
microsoft.graph.geolocationColumn:
title: geolocationColumn
type: object
additionalProperties:
type: object
microsoft.graph.hyperlinkOrPictureColumn:
title: hyperlinkOrPictureColumn
type: object
properties:
isPicture:
type: boolean
description: Specifies whether the display format used for URL columns is an image or a hyperlink.
nullable: true
additionalProperties:
type: object
microsoft.graph.lookupColumn:
title: lookupColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Indicates whether multiple values can be selected from the source.
nullable: true
allowUnlimitedLength:
type: boolean
description: Indicates whether values in the column should be able to exceed the standard limit of 255 characters.
nullable: true
columnName:
type: string
description: The name of the lookup source column.
nullable: true
listId:
type: string
description: The unique identifier of the lookup source list.
nullable: true
primaryLookupColumnId:
type: string
description: 'If specified, this column is a secondary lookup, pulling an additional field from the list item looked up by the primary lookup. Use the list item looked up by the primary as the source for the column named here.'
nullable: true
additionalProperties:
type: object
microsoft.graph.numberColumn:
title: numberColumn
type: object
properties:
decimalPlaces:
type: string
description: How many decimal places to display. See below for information about the possible values.
nullable: true
displayAs:
type: string
description: 'How the value should be presented in the UX. Must be one of number or percentage. If unspecified, treated as number.'
nullable: true
maximum:
type: number
description: The maximum permitted value.
format: double
nullable: true
minimum:
type: number
description: The minimum permitted value.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.personOrGroupColumn:
title: personOrGroupColumn
type: object
properties:
allowMultipleSelection:
type: boolean
description: Indicates whether multiple values can be selected from the source.
nullable: true
chooseFromType:
type: string
description: 'Whether to allow selection of people only, or people and groups. Must be one of peopleAndGroups or peopleOnly.'
nullable: true
displayAs:
type: string
description: How to display the information about the person or group chosen. See below.
nullable: true
additionalProperties:
type: object
microsoft.graph.contentTypeInfo:
title: contentTypeInfo
type: object
properties:
id:
type: string
description: The ID of the content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
additionalProperties:
type: object
microsoft.graph.termColumn:
title: termColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Specifies whether the column allows more than one value.
nullable: true
showFullyQualifiedName:
type: boolean
description: Specifies whether to display the entire term path or only the term label.
nullable: true
parentTerm:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
termSet:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
additionalProperties:
type: object
microsoft.graph.textColumn:
title: textColumn
type: object
properties:
allowMultipleLines:
type: boolean
description: Whether to allow multiple lines of text.
nullable: true
appendChangesToExistingText:
type: boolean
description: 'Whether updates to this column should replace existing text, or append to it.'
nullable: true
linesForEditing:
maximum: 2147483647
minimum: -2147483648
type: number
description: The size of the text box.
format: int32
nullable: true
maxLength:
maximum: 2147483647
minimum: -2147483648
type: number
description: The maximum number of characters for the value.
format: int32
nullable: true
textType:
type: string
description: The type of text being stored. Must be one of plain or richText
nullable: true
additionalProperties:
type: object
microsoft.graph.thumbnailColumn:
title: thumbnailColumn
type: object
additionalProperties:
type: object
microsoft.graph.columnTypes:
title: columnTypes
enum:
- note
- text
- choice
- multichoice
- number
- currency
- dateTime
- lookup
- boolean
- user
- url
- calculated
- location
- geolocation
- term
- multiterm
- thumbnail
- approvalStatus
- unknownFutureValue
type: string
microsoft.graph.columnValidation:
title: columnValidation
type: object
properties:
defaultLanguage:
type: string
description: Default BCP 47 language tag for the description.
nullable: true
descriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.displayNameLocalization'
description: Localized messages that explain what is needed for this column's value to be considered valid. User will be prompted with this message if validation fails.
formula:
type: string
description: 'The formula to validate column value. For examples, see Examples of common formulas in lists.'
nullable: true
additionalProperties:
type: object
microsoft.graph.documentSet:
title: documentSet
type: object
properties:
allowedContentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
description: Content types allowed in document set.
defaultContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
description: Default contents of document set.
propagateWelcomePageChanges:
type: boolean
description: Specifies whether to push welcome page changes to inherited content types.
nullable: true
shouldPrefixNameToFile:
type: boolean
description: Indicates whether to add the name of the document set to each file name.
nullable: true
welcomePageUrl:
type: string
description: Welcome page absolute URL.
nullable: true
sharedColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
welcomePageColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.documentSetContent:
title: documentSetContent
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
fileName:
type: string
description: Name of the file in resource folder that should be added as a default content or a template in the document set.
nullable: true
folderName:
type: string
description: Folder name in which the file will be placed when a new document set is created in the library.
nullable: true
additionalProperties:
type: object
microsoft.graph.contentTypeOrder:
title: contentTypeOrder
type: object
properties:
default:
type: boolean
description: Indicates whether this is the default content type
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: Specifies the position in which the content type appears in the selection UI.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.columnLink:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnLink
type: object
properties:
name:
type: string
description: The name of the column in this content type.
nullable: true
additionalProperties:
type: object
microsoft.graph.pageLayoutType:
title: pageLayoutType
enum:
- microsoftReserved
- article
- home
- unknownFutureValue
type: string
microsoft.graph.sharePointIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: sharePointIdentitySet
type: object
properties:
group:
$ref: '#/components/schemas/microsoft.graph.identity'
sharePointGroup:
$ref: '#/components/schemas/microsoft.graph.sharePointGroupIdentity'
siteGroup:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
siteUser:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
additionalProperties:
type: object
microsoft.graph.sharingInvitation:
title: sharingInvitation
type: object
properties:
email:
type: string
description: The email address provided for the recipient of the sharing invitation. Read-only.
nullable: true
invitedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
redeemedBy:
type: string
nullable: true
signInRequired:
type: boolean
description: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.sharingLink:
title: sharingLink
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
preventsDownload:
type: boolean
description: 'If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.'
nullable: true
scope:
type: string
description: 'The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.'
nullable: true
type:
type: string
description: The type of the link created.
nullable: true
webHtml:
type: string
description: 'For embed links, this property contains the HTML code for an