Update inheritablePermission

Namespace: microsoft.graph

Update the properties of an inheritablePermission object on an agent identity blueprint. When moving to a more restrictive inheritance pattern, such as from allAllowedScopes to enumeratedScopes or noScopes, any agent identities that require access will require new consent grant to acquire the newly restricted scopes.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

HTTP request

PATCH /applications/{id}/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/{resourceAppId}

Request headers

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Response

If successful, this method returns a 200 OK response code and an updated inheritablePermission object in the response body.

Examples

Example 1: Update inheritablePermission to use allAllowedScopes pattern

This example updates an existing inheritablePermission to use the allAllowedScopes inheritance pattern, allowing all delegated permission scopes from the resource application to be inheritable by agent identities.

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/applications/bc057821-f236-49d6-9f2c-1ebf43e9437a/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/00000003-0000-0ff1-ce00-000000000000
Content-Type: application/json

{
  "inheritableScopes": {
    "@odata.type": "microsoft.graph.allAllowedScopes"
  }
}

const options = {
	authProvider,
};

const client = Client.init(options);

const inheritablePermission = {
  inheritableScopes: {
    '@odata.type': 'microsoft.graph.allAllowedScopes'
  }
};

await client.api('/applications/bc057821-f236-49d6-9f2c-1ebf43e9437a/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/00000003-0000-0ff1-ce00-000000000000')
	.version('beta')
	.update(inheritablePermission);

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 2: Update inheritablePermission to use enumeratedScopes pattern

This example updates an existing inheritablePermission to use the enumeratedScopes inheritance pattern, allowing only the specified delegated permission scopes from the resource application to be inheritable by agent identities.

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/applications/bc057821-f236-49d6-9f2c-1ebf43e9437a/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/00000003-0000-0000-c000-000000000000
Content-Type: application/json

{
  "inheritableScopes": {
    "@odata.type": "microsoft.graph.enumeratedScopes",
    "scopes": [
      "User.Read",
      "Mail.Read"
    ]
  }
}

const options = {
	authProvider,
};

const client = Client.init(options);

const inheritablePermission = {
  inheritableScopes: {
    '@odata.type': 'microsoft.graph.enumeratedScopes',
    scopes: [
      'User.Read',
      'Mail.Read'
    ]
  }
};

await client.api('/applications/bc057821-f236-49d6-9f2c-1ebf43e9437a/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/00000003-0000-0000-c000-000000000000')
	.version('beta')
	.update(inheritablePermission);

Response

The following example shows the response.

HTTP/1.1 204 No Content

Example 3: Update inheritablePermission to use noScopes pattern

This example updates an existing inheritablePermission to use the noScopes inheritance pattern, preventing any delegated permission scopes from the resource application from being inheritable by agent identities.

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/applications/bc057821-f236-49d6-9f2c-1ebf43e9437a/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/00000003-0000-0000-c000-000000000000
Content-Type: application/json

{
  "inheritableScopes": {
    "@odata.type": "microsoft.graph.noScopes"
  }
}

const options = {
	authProvider,
};

const client = Client.init(options);

const inheritablePermission = {
  inheritableScopes: {
    '@odata.type': 'microsoft.graph.noScopes'
  }
};

await client.api('/applications/bc057821-f236-49d6-9f2c-1ebf43e9437a/microsoft.graph.agentIdentityBlueprint/inheritablePermissions/00000003-0000-0000-c000-000000000000')
	.version('beta')
	.update(inheritablePermission);

Response

The following example shows the response.

HTTP/1.1 204 No Content