List customAuthenticationExtensions

Namespace: microsoft.graph

Get a list of the customAuthenticationExtension objects and their properties. The following derived types are supported.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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) CustomAuthenticationExtension.Read.All CustomAuthenticationExtension.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application CustomAuthenticationExtension.Read.All CustomAuthenticationExtension.ReadWrite.All

Important

In delegated scenarios with work or school accounts, the admin must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:

  • Global Reader
  • Authentication Extensibility Administrator
  • Application Administrator

HTTP request

GET /identity/customAuthenticationExtensions

Optional query parameters

This method supports the $filter OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of customAuthenticationExtension objects in the response body. An @odata.type property is returned for each object to specify the type of customAuthenticationExtension.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions?$filter=isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/customAuthenticationExtensions",
    "value": [
        {
            "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e",
            "displayName": "onTokenIssuanceStartCustomExtension",
            "description": "Fetch additional claims from custom user store",
            "clientConfiguration": null,
            "authenticationConfiguration": {
                "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
                "resourceId": "api://authenticationeventsAPI.contoso.net/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
            },
            "endpointConfiguration": {
                "@odata.type": "#microsoft.graph.httpRequestEndpoint",
                "targetUrl": "https://authenticationeventsAPI.contoso.net"
            },
            "claimsForTokenConfiguration": [
                {
                    "claimIdInApiResponse": "DateOfBirth"
                },
                {
                    "claimIdInApiResponse": "CustomRoles"
                }
            ]
        }
    ]
}