Create roleManagementCustomCalloutExtension

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.

Create a roleManagementCustomCalloutExtension object for Privileged Identity Management (PIM).

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.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	PrivilegedAccess-CustomExt.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	PrivilegedAccess-CustomExt.ReadWrite.All	Not available.

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that grants the permissions required for this operation. Privileged Role Administrator is the least privileged role supported for this operation.

HTTP request

POST /identityGovernance/privilegedAccess/customExtensions

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the roleManagementCustomCalloutExtension object.

Property	Type	Description
authenticationConfiguration	customExtensionAuthenticationConfiguration	The authentication configuration used to secure calls to the external app. Optional.
clientConfiguration	customExtensionClientConfiguration	The timeout and retry settings for calls to the external app. Optional.
customAttributes	String collection	The custom attribute names to include in the callout payload. Required.
description	String	The description of the custom extension. Optional.
displayName	String	The display name of the custom extension. Optional.
endpointConfiguration	customExtensionEndpointConfiguration	The configuration for the external endpoint that PIM calls. Optional.
isEnabled	Boolean	Indicates whether the custom extension is enabled. Optional.
resourceType	customExtensionResourceType	The PIM provider to which the extension applies. The possible values are: entraRoles, azureResources, entraGroups, unknownFutureValue, applicationAuthorization, appRoles. Required.
type	customCalloutExtensionType	The lifecycle stage at which PIM invokes the extension. The possible values are: preApproval, postApproval, grant, revoke, unknownFutureValue. Required.

For the applicationAuthorization and appRoles values of resourceType to be returned in responses, use the Prefer: include-unknown-enum-members request header. For more information, see Handling future members in evolvable enumerations.

Response

If successful, this method returns a 201 Created response code and a roleManagementCustomCalloutExtension object in the response body.

Examples

Request

The following example creates an enabled preapproval extension for PIM for Microsoft Entra roles.

POST https://graph.microsoft.com/beta/identityGovernance/privilegedAccess/customExtensions
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.roleManagementCustomCalloutExtension",
  "displayName": "Role assignment ticket validation",
  "description": "Validates ticket information against the service desk",
  "resourceType": "entraRoles",
  "type": "preApproval",
  "customAttributes": ["department", "costCenter"],
  "isEnabled": true,
  "endpointConfiguration": {
    "@odata.type": "#microsoft.graph.httpRequestEndpoint",
    "targetUrl": "https://api.contoso.com/webhooks/role-assignments"
  },
  "clientConfiguration": {
    "timeoutInMilliseconds": 10000,
    "maximumRetries": 3
  },
  "authenticationConfiguration": {
    "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
    "resourceId": "api://api.contoso.com/00001111-aaaa-2222-bbbb-3333cccc4444"
  }
}

Response

The following example shows the response.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.roleManagementCustomCalloutExtension",
  "id": "a1b2c3d4-e5f6-4a5b-8c9d-0e1f2a3b4c5d",
  "displayName": "Role assignment ticket validation",
  "description": "Validates ticket information against the service desk",
  "resourceType": "entraRoles",
  "type": "preApproval",
  "customAttributes": ["department", "costCenter"],
  "isEnabled": true,
  "endpointConfiguration": {
    "@odata.type": "#microsoft.graph.httpRequestEndpoint",
    "targetUrl": "https://api.contoso.com/webhooks/role-assignments"
  },
  "clientConfiguration": {
    "timeoutInMilliseconds": 10000,
    "maximumRetries": 3
  },
  "authenticationConfiguration": {
    "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
    "resourceId": "api://api.contoso.com/00001111-aaaa-2222-bbbb-3333cccc4444"
  }
}