CustomAuthenticationExtension.Receive.Payload

Permission Details

Application Permission

Receive custom authentication extension HTTP requests

Allows custom authentication extensions associated with the app to receive HTTP requests triggered by an authentication event. The request can include information about a user, client and resource service principals, and other information about the authentication.

Permission ID: 214e810f-fda8-4fd7-a475-29461495eb00

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`authenticationConfiguration`	`customExtensionAuthenticationConfiguration`	The authentication configuration for the customAuthenticationExtension. Inherited from customCalloutExtension.
`behaviorOnError`	`customExtensionBehaviorOnError`	The behaviour on error for the custom authentication extension.
`clientConfiguration`	`customExtensionClientConfiguration`	The connection settings for the customAuthenticationExtension. Inherited from customCalloutExtension.
`description`	`String`Nullable	The description of the customAuthenticationExtension. Inherited from customCalloutExtension.
`displayName`	`String`Nullable	The display name for the customAuthenticationExtension. Inherited from customCalloutExtension.
`endpointConfiguration`	`customExtensionEndpointConfiguration`	The HTTP endpoint that this custom extension calls. Inherited from customCalloutExtension.
`id`	`String`	Identifier for the customAuthenticationExtension. Inherited from entity.

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@odata.type": "#microsoft.graph.customAuthenticationExtension",
  "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"
  },
  "behaviorOnError": {
    "@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
  }
}

Relationships

Relationships metadata is not available for this permission mapping.

View resource documentation

Graph Methods

Delegated access App-only access

No Learn or OpenAPI mapping available

Microsoft Graph v1.0 endpoints are not available from refreshed Microsoft Learn or Microsoft Graph OpenAPI metadata for this permission.

No API methods available for this version.

No Learn or OpenAPI mapping available

Microsoft Graph beta endpoints are not available from refreshed Microsoft Learn or Microsoft Graph OpenAPI metadata for this permission.

No API methods available for this version.

No Microsoft Learn PowerShell mapping available

Microsoft Graph PowerShell v1.0 commands are not available from refreshed Microsoft Learn PowerShell snippets for this permission.

No deterministic PowerShell command map is available for this permission.

Browse PowerShell docs

No Microsoft Learn PowerShell mapping available

Microsoft Graph PowerShell beta commands are not available from refreshed Microsoft Learn PowerShell snippets for this permission.

No deterministic PowerShell command map is available for this permission.

Browse PowerShell docs

Code Examples

C# / .NET SDK

using Azure.Identity;
using Microsoft.Graph;

var scopes = new[] { "CustomAuthenticationExtension.Receive.Payload" };
var credential = new InteractiveBrowserCredential(
    new InteractiveBrowserCredentialOptions
    {
        ClientId = "YOUR_CLIENT_ID",
        TenantId = "YOUR_TENANT_ID",
        RedirectUri = new Uri("http://localhost")
    });

var graphClient = new GraphServiceClient(credential, scopes);
var response = await graphClient
    .WithUrl("https://graph.microsoft.com/v1.0/customauthenticationextension")
    .GetAsync();

JavaScript

import { Client } from "@microsoft/microsoft-graph-client";
import { InteractiveBrowserCredential } from "@azure/identity";

const credential = new InteractiveBrowserCredential({
  clientId: "YOUR_CLIENT_ID",
  tenantId: "YOUR_TENANT_ID",
  redirectUri: "http://localhost"
});

const token = await credential.getToken(["CustomAuthenticationExtension.Receive.Payload"]);
const client = Client.init({
  authProvider: (done) => done(null, token.token)
});

const response = await client.api("/customauthenticationextension").get();

PowerShell

Connect-MgGraph -Scopes "CustomAuthenticationExtension.Receive.Payload"
Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/customauthenticationextension"

Python

from azure.identity import InteractiveBrowserCredential
import requests

credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)

token = credential.get_token("CustomAuthenticationExtension.Receive.Payload")
response = requests.get(
    "https://graph.microsoft.com/v1.0/customauthenticationextension",
    headers={"Authorization": f"Bearer {token.token}"}
)

print(response.json())

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions and search for CustomAuthenticationExtension.Receive.Payload

4

Grant Admin Consent

Application permissions always require admin consent.