命名空间:microsoft.graph
读取 customAuthenticationExtension 对象的属性和关系。 当前支持以下派生类型。
- onTokenIssuanceStartCustomExtension 资源类型。
- onAttributeCollectionStartCustomExtension 资源类型。
- onAttributeCollectionSubmitCustomExtension 资源类型。
- onOtpSendCustomExtension 资源类型。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 | 
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ | 
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 | 
|---|---|---|
| 委派(工作或学校帐户) | CustomAuthenticationExtension.Read.All | CustomAuthenticationExtension.ReadWrite.All | 
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 | 
| 应用程序 | CustomAuthenticationExtension.Read.All | CustomAuthenticationExtension.ReadWrite.All | 
重要
在具有工作或学校帐户的委派方案中,必须为管理员分配受支持的Microsoft Entra角色或具有受支持角色权限的自定义角色。 此作支持以下最低特权角色:
- 全局读取者
- 身份验证扩展性管理员
- 应用程序管理员
HTTP 请求
GET /identity/customAuthenticationExtensions/{customAuthenticationExtensionId}
可选的查询参数
此方法支持 $select OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数。
请求标头
| 名称 | 说明 | 
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 | 
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回响应 200 OK 代码和 customAuthenticationExtension 对象。
示例
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/customAuthenticationExtensions/$entity",
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
    "id": "6fc5012e-7665-43d6-9708-4370863f4e6e",
    "displayName": "onTokenIssuanceStartCustomExtension",
    "description": "Fetch additional claims from custom user store",
    "clientConfiguration": null,
    "behaviorOnError": null,
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
    },
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.httpRequestEndpoint",
        "targetUrl": "https://authenticationeventsAPI.contoso.com"
    },
    "claimsForTokenConfiguration": [
        {
            "claimIdInApiResponse": "DateOfBirth"
        },
        {
            "claimIdInApiResponse": "CustomRoles"
        }
    ]
}