Edit

roleManagementCustomCalloutExtension resource type

Namespace: microsoft.graph

Represents a custom workflow extension for Privileged Identity Management (PIM) role management operations. Use this resource to integrate external approval, ticketing, compliance, audit, or notification systems into role assignment lifecycle events for Microsoft Entra roles, Azure resources, and groups.

Inherits from customCalloutExtension.

Methods

Method Return type Description
List roleManagementCustomCalloutExtension collection Get a list of PIM custom extensions.
Create roleManagementCustomCalloutExtension Create a PIM custom extension.
Get roleManagementCustomCalloutExtension Retrieve a PIM custom extension.
Update roleManagementCustomCalloutExtension Update a PIM custom extension.
Delete None Delete a PIM custom extension.

Properties

Property Type Description
authenticationConfiguration customExtensionAuthenticationConfiguration The authentication configuration used to secure calls to the external app. Inherited from customCalloutExtension.
clientConfiguration customExtensionClientConfiguration The HTTP connection settings for calls to the external app. Inherited from customCalloutExtension.
customAttributes String collection The custom attribute names to include in the callout payload.
description String The description of the custom extension. Inherited from customCalloutExtension.
displayName String The display name of the custom extension. Inherited from customCalloutExtension.
endpointConfiguration customExtensionEndpointConfiguration The configuration for the external endpoint that PIM calls. Inherited from customCalloutExtension.
id String The unique identifier for the custom extension. Inherited from entity.
resourceType customExtensionResourceType The PIM provider to which the extension applies. The possible values are: entraRoles, azureResources, entraGroups, unknownFutureValue. Supports $filter (eq).
type customCalloutExtensionType The role assignment lifecycle stage at which PIM invokes the extension. The possible values are: preApproval, postApproval, grant, revoke, unknownFutureValue.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.roleManagementCustomCalloutExtension",
  "id": "String (identifier)",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
  },
  "clientConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionClientConfiguration"
  },
  "customAttributes": ["String"],
  "description": "String",
  "displayName": "String",
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
  },
  "resourceType": "String",
  "type": "String"
}