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 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')
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.CustomAuthenticationExtensions.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')";
});
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphidentity "github.com/microsoftgraph/msgraph-sdk-go/identity"
//other-imports
)
requestFilter := "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')"
requestParameters := &graphidentity.IdentityCustomAuthenticationExtensionsRequestBuilderGetQueryParameters{
Filter: &requestFilter,
}
configuration := &graphidentity.IdentityCustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
customAuthenticationExtensions, err := graphClient.Identity().CustomAuthenticationExtensions().Get(context.Background(), configuration)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CustomAuthenticationExtensionCollectionResponse result = graphClient.identity().customAuthenticationExtensions().get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')";
});
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
let customAuthenticationExtensions = await client.api('/identity/customAuthenticationExtensions')
.filter('isOf(\'microsoft.graph.onTokenIssuanceStartCustomExtension\')')
.get();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Identity\CustomAuthenticationExtensions\CustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new CustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration();
$queryParameters = CustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->identity()->customAuthenticationExtensions()->get($requestConfiguration)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Identity.SignIns
Get-MgIdentityCustomAuthenticationExtension -Filter "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')"
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.identity.custom_authentication_extensions.custom_authentication_extensions_request_builder import CustomAuthenticationExtensionsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = CustomAuthenticationExtensionsRequestBuilder.CustomAuthenticationExtensionsRequestBuilderGetQueryParameters(
filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.identity.custom_authentication_extensions.get(request_configuration = request_configuration)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
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"
}
]
}
]
}