roleManagementCustomCalloutExtension resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

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.

Objects of this type belong to the customExtensions relationship of privilegedAccessRoot.

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.
isEnabled	Boolean	Indicates whether the custom extension is enabled.
resourceType	customExtensionResourceType	The PIM provider to which the extension applies. The possible values are: entraRoles, azureResources, entraGroups, unknownFutureValue, applicationAuthorization, appRoles. Use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enumeration: applicationAuthorization, appRoles. 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"
  },
  "description": "String",
  "displayName": "String",
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
  },
  "resourceType": "String",
  "customAttributes": [
    "String"
  ],
  "isEnabled": "Boolean",
  "type": "String"
}