教程：在 Microsoft Entra ID 中开发 SCIM 终结点并计划其预配
应用程序开发人员可以使用跨域身份管理系统 (SCIM) 用户管理 API 实施在应用程序与 Microsoft Entra ID 之间自动预配用户和组。 本文介绍如何生成 SCIM 终结点以及如何与 Microsoft Entra 预配服务集成。 SCIM 规范提供了预配用的常见用户架构。 与联合标准（例如 SAML 或 OpenID Connect）配合使用时，SCIM 为管理员提供了基于标准的端到端访问权限管理解决方案。
SCIM 2.0 是 /Users 终结点和 /Groups 终结点的标准化定义。 它使用常见的 REST API 终结点来创建、更新和删除对象。 SCIM 由公共特性（例如组名、用户名、名字、姓氏和电子邮件）的预定义架构构成。
提供 SCIM 2.0 REST API 的应用可以减少或免去使用专有用户管理 API 带来的麻烦。 例如，任何兼容的 SCIM 客户端都知道如何将 JSON 对象的 HTTP POST 发送到 /Users 终结点，以创建新的用户条目。 符合 SCIM 标准的应用不需要采用略有不同的 API 来执行相同的基本操作，而是可以立即使用现有的客户端、工具和代码。
SCIM 2.0 (RFC 7642、7643、7644) 中定义的用于管理的标准用户对象架构和 REST API 允许标识提供者和应用更轻松地相互集成。 生成 SCIM 终结点的应用程序开发人员无需执行自定义工作即可与任何符合 SCIM 的客户端集成。
若要自动预配到应用程序，需要生成并集成 Microsoft Entra 预配服务可访问的 SCIM 终结点。 采用以下步骤，开始将用户和组预配到应用程序中。
设计用户和组架构 - 确定应用程序的对象和特性，确定它们如何映射到 Microsoft Entra SCIM 实施支持的用户和组架构。
了解 Microsoft Entra SCIM 实施 - 了解如何实施 Microsoft Entra 预配服务以对 SCIM 协议请求处理和响应进行建模。
生成 SCIM 终结点 - 终结点必须与 SCIM 2.0 兼容，才能与 Microsoft Entra 预配服务集成。 可以选择使用 Microsoft 公共语言基础结构 (CLI) 库和代码示例来生成终结点。 这些示例仅供参考和测试；建议不要在生产应用中依赖这些示例。
将 SCIM 终结点与 Microsoft Entra 预配服务集成。 Microsoft Entra ID 支持多个实施 SCIM 2.0 的第三方应用程序。 如果使用其中一个应用程序，则可以快速自动预配和取消预配用户和组。
[可选] 将应用程序发布到 Microsoft Entra 应用程序库 - 使客户轻松发现应用程序并轻松配置预配。
设计用户和组架构
每个应用程序都需要不同的特性才能创建用户或组。 通过标识应用程序所需的对象（users 和 groups）和特性（name、manager、job title 等）开始集成。
SCIM 标准定义用于管理用户和组的架构。
用户架构仅需要三种特性（所有其他特性为可选项）：
id，服务提供商定义的标识符userName，用户的唯一标识符（通常对应于 Microsoft Entra 用户主体名称）meta，由服务提供商维护的只读元数据
除了核心用户架构外，SCIM 标准还定义了企业用户扩展以及用于扩展用户架构的模型，以满足应用程序的需求。
例如，如果应用程序同时需要用户的电子邮件和用户的管理员，请使用核心架构来收集用户的电子邮件，并使用企业用户架构来收集用户的管理员。
若要设计架构，请执行以下步骤：
列出应用程序所需的特性，然后分类为身份验证所需的特性（例如登录名和电子邮件）。 用户生命周期管理所需的特性（例如状态/活动），以及应用程序正常工作所需的所有其他特性（例如管理器、标记）。
检查这些特性是否已在核心用户架构或企业用户架构中定义 。 如果没有，则必须为涵盖缺少的特性的用户架构定义扩展。 请参阅示例，了解如何扩展到用户以允许预配用户
tag。将 SCIM 特性映射到 Microsoft Entra ID 中的用户特性。 如果 SCIM 终结点中定义的其中一种特性在 Microsoft Entra 用户架构中没有明确的对应项，请指导租户管理员扩展其架构或对
tags特性使用扩展特性，如示例所示。
下表列出了所需特性的示例：
| 必需的应用属性/示例 | 映射的 SCIM 特性 | 映射的 Microsoft Entra 特性 |
|---|---|---|
| loginName | userName | userPrincipalName |
| firstName | name.givenName | givenName |
| lastName | name.familyName | surName |
| workMail | emails[type eq "work"].value | |
| manager | manager | manager |
| 标记 | urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:tag |
extensionAttribute1 |
| status | 活动 | isSoftDeleted（计算值不存储在用户上） |
以下 JSON 有效负载演示了 SCIM 架构示例：
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User"],
"userName":"bjensen@testuser.com",
"id": "48af03ac28ad4fb88478",
"externalId":"bjensen",
"name":{
"familyName":"Jensen",
"givenName":"Barbara"
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"manager": "123456"
},
"urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User": {
"tag": "701984",
},
"meta": {
"resourceType": "User",
"created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff591\"",
"location":
"https://example.com/v2/Users/00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
}
}
注意
除了应用程序所需的特性，JSON 表示形式还包括所需的 id、externalId 和 meta 特性。
它有助于在 /User 和 /Group 之间进行分类，以便将 Microsoft Entra 中的任何默认用户特性映射到 SCIM RFC，请参阅 Microsoft Entra ID 与 SCIM 终结点之间映射自定义特性的方式。
下表列出了用户特性的示例：
| Microsoft Entra 用户 | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User |
|---|---|
| IsSoftDeleted | 活动 |
| department | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department |
| displayName | displayName |
| employeeId | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber |
| Facsimile-TelephoneNumber | phoneNumbers[type eq "fax"].value |
| givenName | name.givenName |
| jobTitle | title |
| emails[type eq "work"].value | |
| mailNickname | externalId |
| manager | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager |
| mobile | phoneNumbers[type eq "mobile"].value |
| postalCode | addresses[type eq "work"].postalCode |
| proxy-Addresses | emails[type eq "other"].Value |
| physical-Delivery-OfficeName | addresses[type eq "other"].Formatted |
| streetAddress | addresses[type eq "work"].streetAddress |
| surname | name.familyName |
| telephone-Number | phoneNumbers[type eq "work"].value |
| user-PrincipalName | userName |
下表列出了组特性的示例：
| Microsoft Entra 组 | urn:ietf:params:scim:schemas:core:2.0:Group |
|---|---|
| displayName | displayName |
| members | members |
| objectId | externalId |
注意
无需同时支持用户和组或支持此处所示的所有特性，这仅仅是关于 Microsoft Entra ID 中的特性通常以何种方式映射到 SCIM 协议中的特性的参考。
SCIM RFC 中定义了多个终结点。 可以从 /User 终结点开始，然后从该处扩展。 下表列出了一些 SCIM 终结点：
| 终结点 | 说明 |
|---|---|
| /User | 对用户对象执行 CRUD 操作。 |
| /Group | 对组对象执行 CRUD 操作。 |
| /Schemas | 每个客户端和服务提供商支持的属性集可能有所不同。 一个服务提供商可能包括 name、title 和 emails 属性，而另一个服务提供商使用 name、title 和 phoneNumbers 属性。 利用架构终结点可以发现受支持的属性。 |
| /Bulk | 借助批量操作，可以通过单个操作（例如更新大型组的成员身份）对大量资源对象执行操作。 |
| /ServiceProviderConfig | 详细说明受支持的 SCIM 标准的特点（例如受支持的资源和身份验证方法）。 |
| /ResourceTypes | 指定每个资源的元数据。 |
注意
使用 /Schemas 终结点支持自定义属性；如果架构经常更改，因为它使客户端能够自动检索最新的架构，则也可以使用该终结点。 使用 /Bulk 终结点支持组。
了解 Microsoft Entra SCIM 实施
Microsoft Entra 预配服务旨在支持 SCIM 2.0 用户管理 API。
重要
Microsoft Entra SCIM 实施的行为最近于 2018 年 12 月 18 日更新。 有关更改内容的信息，请参阅 Microsoft Entra 用户预配服务 SCIM 2.0 协议合规性。
在 SCIM 2.0 协议规范中，应用程序必须满足以下要求：
| 要求 | 引用说明（SCIM 协议） |
|---|---|
| 创建用户和组（可选） | 第 3.3 部分 |
| 通过 PATCH 请求修改用户或组 | 第 3.5.2 部分。 支持可确保以高性能的方式预配组和用户。 |
| 为之前创建的用户或组检索已知资源 | 第 3.4.1 部分 |
| 查询用户或组 | 第 3.4.2 部分。 默认情况下，使用 id 检索用户，使用 username 和 externalId 查询用户，以及使用 displayName 查询组。 |
| 查询组资源时的筛选器 excludedAttributes=members | 第 3.4.2.2 部分 |
| 支持列出用户和分页 | 第 3.4.2.4 部分。 |
软删除用户 active=false 并还原该用户 active=true |
无论用户是否处于活动状态，都应在请求中返回用户对象。 不应返回用户的唯一例外是，从应用程序中硬删除用户的情况。 |
| 支持架构终结点 | 第 7 部分使用架构发现终结点发现更多属性。 |
| 接受使用一个持有者令牌对应用程序进行 Microsoft Entra ID 身份验证和授权。 |
实施 SCIM 终结点时，请遵从以下一般准则，以确保与 Microsoft Entra ID 兼容：
常规：
id是所有资源的必需属性。 每个返回资源的响应都应确保每个资源都具有此属性，但元素数量为零的ListResponse除外。- 发送的值应采用发送时的格式存储。 应拒绝无效值，并显示一条可操作的描述性错误消息。 Microsoft Entra ID 中的数据与 SCIM 应用程序中存储的数据之间不应发生数据转换。 （例如， 以 55555555555 格式发送的电话号码不应保存/返回为 +5 (555) 555-5555）
- 不必在 PATCH 响应中包含整个资源。
- 对于 SCIM 中的结构元素，不要求区分大小写匹配，尤其是第 3.5.2 节中定义的 PATCH
op操作值。 Microsoft Entra ID 发出op的值，分别为 Add、Replace 和 Remove。 - Microsoft Entra ID 发出用于提取随机用户和组的请求，以确保终结点和凭据有效。 在“测试连接”流中也会完成此操作。
- 在 SCIM 终结点上支持 HTTPS。
- 支持自定义的复杂特性和多值特性，但在这些情况下，Microsoft Entra ID 中可供拉取数据的复杂数据结构不多。 可以轻松映射到名称/值属性，但不支持将数据流向具有三个或更多个子属性的复杂属性。
- 多值复杂特性的“type”子特性值必须是唯一的。 例如，“work”子类型不能有两个不同的电子邮件地址。
- 所有响应的标头应为 content 类型：application/scim+json
检索资源：
- 对查询/筛选请求的响应应始终为
ListResponse。 - Microsoft Entra 仅使用以下运算符：
eq、and - 应将可以查询其资源的特性设置为应用程序的匹配特性，请参阅自定义用户设置特性映射。
/Users：
- 不支持权利特性。
- 任何被视为用户唯一性的属性都必须能够作为筛选查询的一部分使用。 （例如，如果用户唯一性是针对 userName 和 emails[type eq "work"] 进行评估，则带有筛选器的 GET to /Users 必须同时支持 userName eq "user@contoso.com" 和 emails[type eq "work"].value eq "user@contoso.com" 查询。
/Groups：
- 组是可选项，但只有在 SCIM 实现支持 PATCH 请求时才受支持。
- 组的“displayName”值必须具有唯一性，才能与 Microsoft Entra ID 和 SCIM 应用程序匹配。 这种唯一性不是 SCIM 协议的要求，而是将 SCIM 终结点与 Microsoft Entra ID 集成的要求。
/Schemas（架构发现）：
- 示例请求/响应
- 架构发现正在某些库应用程序中使用。 架构发现是向现有库 SCIM 应用程序的架构添加更多特性的唯一方法。 自定义非库 SCIM 应用程序当前不支持架构发现。
- 如果值不存在，请不要发送 null 值。
- 属性值应采用大小写形式（例如 readWrite）。
- 必须返回列表响应。
- 当你保存预配配置时，Microsoft Entra 预配服务会发出 /schemas 请求。 打开“编辑预配”页时，也会发出该请求。 在目标特性列表下的特性映射中，将向客户显示发现的其他特性。 架构发现仅会导致添加更多目标特性。 不会移除特性。
用户预配和取消预配
下图显示了 Microsoft Entra ID 发送到 SCIM 终结点以管理应用程序的标识存储区中用户的生命周期的消息。
组预配和取消预配
组预配和取消预配是可选操作。 在实施并启用后，下图显示了 Microsoft Entra ID 发送到 SCIM 终结点以管理应用程序的标识存储区中组的生命周期的消息。 这些消息在以下两个方面与用户相关的消息不同：
- 检索组的请求指定将成员属性从请求响应中提供的任何资源中排除。
- 确定引用属性是否具有特定值的请求是有关成员属性的请求。
下图显示了组取消预配顺序：
SCIM 协议请求和响应
本文提供 Microsoft Entra 预配服务发出的 SCIM 请求示例以及预期响应示例。 为了获得最佳结果，应将应用编码为按此格式处理这些请求并发出预期的响应。
重要
若要了解 Microsoft Entra 用户预配服务如何以及何时发出示例中所述的操作，请参阅预配工作原理中的预配周期：初始和增量部分。
- 创建用户（请求 / 响应）
- 获取用户（请求 / 响应）
- 通过查询获取用户（请求 / 响应）
- 通过查询获取用户 - 零个结果（请求 / 响应）
- 更新用户[多值属性]（请求 / 响应）
- 更新用户[单值属性]（请求 / 响应）
- 禁用用户（请求 / 响应）
- 删除用户（请求 / 响应）
- 创建组（请求 / 响应）
- 获取组（请求 / 响应）
- 按 displayName 获取组（请求 / 响应）
- 更新组[非成员属性]（请求 / 响应）
- 更新组[添加成员]（请求 / 响应）
- 更新组[删除成员]（请求 / 响应）
- 删除组（请求 / 响应）
用户操作
- 使用
userName或emails[type eq "work"]属性来查询用户。
创建用户
请求
POST /Users
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
"externalId": "0a21f0f2-8d2a-4f8e-bf98-7363c4aed4ef",
"userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"active": true,
"emails": [{
"primary": true,
"type": "work",
"value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com"
}],
"meta": {
"resourceType": "User"
},
"name": {
"formatted": "givenName familyName",
"familyName": "familyName",
"givenName": "givenName"
},
"roles": []
}
响应
HTTP/1.1 201 已创建
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "48af03ac28ad4fb88478",
"externalId": "0a21f0f2-8d2a-4f8e-bf98-7363c4aed4ef",
"meta": {
"resourceType": "User",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"name": {
"formatted": "givenName familyName",
"familyName": "familyName",
"givenName": "givenName",
},
"active": true,
"emails": [{
"value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
"type": "work",
"primary": true
}]
}
获取用户
请求
GET /Users/5d48a0a8e9f04aa38008
响应（找到用户）
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "5d48a0a8e9f04aa38008",
"externalId": "58342554-38d6-4ec8-948c-50044d0a33fd",
"meta": {
"resourceType": "User",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"name": {
"formatted": "givenName familyName",
"familyName": "familyName",
"givenName": "givenName",
},
"active": true,
"emails": [{
"value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
"type": "work",
"primary": true
}]
}
请求
GET /Users/5171a35d82074e068ce2
响应（找不到用户。不需要详细信息，只需要状态。）
HTTP/1.1 404 找不到
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "404",
"detail": "Resource 23B51B0E5D7AE9110A49411D@7cca31655d49f3640a494224 not found"
}
通过查询获取用户
请求
GET /Users?filter=userName eq "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
响应
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1,
"Resources": [{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "2441309d85324e7793ae",
"externalId": "7fce0092-d52e-4f76-b727-3955bd72c939",
"meta": {
"resourceType": "User",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"name": {
"familyName": "familyName",
"givenName": "givenName"
},
"active": true,
"emails": [{
"value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
"type": "work",
"primary": true
}]
}],
"startIndex": 1,
"itemsPerPage": 20
}
通过查询获取用户 - 零个结果
请求
GET /Users?filter=userName eq "non-existent user"
响应
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 0,
"Resources": [],
"startIndex": 1,
"itemsPerPage": 20
}
更新用户[多值属性]
请求
PATCH /Users/6764549bef60420686bc HTTP/1.1
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "Replace",
"path": "emails[type eq \"work\"].value",
"value": "updatedEmail@microsoft.com"
},
{
"op": "Replace",
"path": "name.familyName",
"value": "updatedFamilyName"
}
]
}
响应
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "6764549bef60420686bc",
"externalId": "6c75de36-30fa-4d2d-a196-6bdcdb6b6539",
"meta": {
"resourceType": "User",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"name": {
"formatted": "givenName updatedFamilyName",
"familyName": "updatedFamilyName",
"givenName": "givenName"
},
"active": true,
"emails": [{
"value": "updatedEmail@microsoft.com",
"type": "work",
"primary": true
}]
}
更新用户[单值属性]
请求
PATCH /Users/5171a35d82074e068ce2 HTTP/1.1
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [{
"op": "Replace",
"path": "userName",
"value": "5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com"
}]
}
响应
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "5171a35d82074e068ce2",
"externalId": "aa1eca08-7179-4eeb-a0be-a519f7e5cd1a",
"meta": {
"resourceType": "User",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"userName": "5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com",
"name": {
"formatted": "givenName familyName",
"familyName": "familyName",
"givenName": "givenName",
},
"active": true,
"emails": [{
"value": "Test_User_11bb11bb-cc22-dd33-ee44-55ff55ff55ff@testuser.com",
"type": "work",
"primary": true
}]
}
禁用用户
请求
PATCH /Users/5171a35d82074e068ce2 HTTP/1.1
{
"Operations": [
{
"op": "Replace",
"path": "active",
"value": false
}
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
]
}
响应
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "CEC50F275D83C4530A495FCF@834d0e1e5d8235f90a495fda",
"userName": "deanruiz@testuser.com",
"name": {
"familyName": "Harris",
"givenName": "Larry"
},
"active": false,
"emails": [
{
"value": "gloversuzanne@testuser.com",
"type": "work",
"primary": true
}
],
"addresses": [
{
"country": "ML",
"type": "work",
"primary": true
}
],
"meta": {
"resourceType": "Users",
"location": "/scim/5171a35d82074e068ce2/Users/CEC50F265D83B4530B495FCF@5171a35d82074e068ce2"
}
}
删除用户
请求
DELETE /Users/5171a35d82074e068ce2 HTTP/1.1
响应
HTTP/1.1 204 无内容
组操作
- 使用空的成员列表创建组。
- 使用
displayName属性来查询组。 - 组 PATCH 请求的更新应在响应中生成“HTTP 204 无内容”。 不建议返回包含所有成员列表的正文。
- 不需要支持返回组的所有成员。
创建组
请求
POST /Groups HTTP/1.1
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group", "http://schemas.microsoft.com/2006/11/ResourceManagement/ADSCIM/2.0/Group"],
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"displayName": "displayName",
"meta": {
"resourceType": "Group"
}
}
响应
HTTP/1.1 201 已创建
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "927fa2c08dcb4a7fae9e",
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"meta": {
"resourceType": "Group",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"displayName": "displayName",
"members": []
}
获取组
请求
GET /Groups/40734ae655284ad3abcc?excludedAttributes=members HTTP/1.1
响应
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "40734ae655284ad3abcc",
"externalId": "60f1bb27-2e1e-402d-bcc4-ec999564a194",
"meta": {
"resourceType": "Group",
"created": "2018-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z"
},
"displayName": "displayName",
}
按 displayName 获取组
请求
GET /Groups?excludedAttributes=members&filter=displayName eq "displayName" HTTP/1.1
响应
HTTP/1.1 200 OK
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1,
"Resources": [{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "8c601452cc934a9ebef9",
"externalId": "0db508eb-91e2-46e4-809c-30dcbda0c685",
"meta": {
"resourceType": "Group",
"created": "2018-03-27T22:02:32.000Z",
"lastModified": "2018-03-27T22:02:32.000Z",
},
"displayName": "displayName",
}],
"startIndex": 1,
"itemsPerPage": 20
}
更新组[非成员属性]
请求
PATCH /Groups/fa2ce26709934589afc5 HTTP/1.1
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [{
"op": "Replace",
"path": "displayName",
"value": "1879db59-3bdf-4490-ad68-ab880a269474updatedDisplayName"
}]
}
响应
HTTP/1.1 204 无内容
更新组[添加成员]
请求
PATCH /Groups/a99962b9f99d4c4fac67 HTTP/1.1
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [{
"op": "Add",
"path": "members",
"value": [{
"$ref": null,
"value": "f648f8d5ea4e4cd38e9c"
}]
}]
}
响应
HTTP/1.1 204 无内容
更新组[删除成员]
请求
PATCH /Groups/a99962b9f99d4c4fac67 HTTP/1.1
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [{
"op": "Remove",
"path": "members",
"value": [{
"$ref": null,
"value": "f648f8d5ea4e4cd38e9c"
}]
}]
}
响应
HTTP/1.1 204 无内容
删除组
请求
DELETE /Groups/cdb1ce18f65944079d37 HTTP/1.1
响应
HTTP/1.1 204 无内容
架构发现
发现架构
请求
获取架构
响应
HTTP/1.1 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"itemsPerPage": 50,
"startIndex": 1,
"totalResults": 3,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id" : "urn:ietf:params:scim:schemas:core:2.0:User",
"name" : "User",
"description" : "User Account",
"attributes" : [
{
"name" : "userName",
"type" : "string",
"multiValued" : false,
"description" : "Unique identifier for the User, typically
used by the user to directly authenticate to the service provider.
Each User MUST include a non-empty userName value. This identifier
MUST be unique across the service provider's entire set of Users.
REQUIRED.",
"required" : true,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "server"
},
],
"meta" : {
"resourceType" : "Schema",
"location" :
"/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
}
},
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id" : "urn:ietf:params:scim:schemas:core:2.0:Group",
"name" : "Group",
"description" : "Group",
"attributes" : [
{
"name" : "displayName",
"type" : "string",
"multiValued" : false,
"description" : "A human-readable name for the Group.
REQUIRED.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
],
"meta" : {
"resourceType" : "Schema",
"location" :
"/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
}
},
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id" : "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"name" : "EnterpriseUser",
"description" : "Enterprise User",
"attributes" : [
{
"name" : "employeeNumber",
"type" : "string",
"multiValued" : false,
"description" : "Numeric or alphanumeric identifier assigned
to a person, typically based on order of hire or association with an
organization.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
],
"meta" : {
"resourceType" : "Schema",
"location" :
"/v2/Schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
}
}
]
}
安全要求
TLS 协议版本
唯一可接受的协议版本是 TLS 1.2。 不允许使用其他 SSL/TLS 版本。
- RSA 密钥必须至少为 2,048 位。
- ECC 密钥必须至少为 256 位，用批准的椭圆曲线生成
密钥长度
所有服务必须使用 X.509 证书，该证书使用足够长的加密密钥生成，这意味着：
密码套件
必须严格按照示例中指定的顺序将所有服务配置为使用以下密码套件。 如果只拥有 RSA 证书，则安装的 ECDSA 密码套件无效。
TLS 1.2 密码套件最低标准：
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
IP 范围
Microsoft Entra 预配服务当前在 Microsoft Entra ID 的 IP 范围下运行，如此处所示。 可以添加 AzureActiveDirectory 标记下面列出的 IP 范围，以允许来自 Microsoft Entra 配置服务的流量进入应用程序。 需要仔细检查 IP 范围列表中的计算地址。 地址（如“40.126.25.32”）可在 IP 范围列表中表示为“40.126.0.0/18”。 还可以使用以下 API以编程方式检索 IP 范围列表。
Microsoft Entra ID 还支持基于代理的解决方案，以提供与专用网络（本地、托管在 Azure 中、托管在 AWS 中等）中的应用程序的连接。 客户可以在其专用网络中的服务器上部署轻量级代理，该代理提供与 Microsoft Entra ID 的连接，而无需打开任何入站端口。 在此处了解更多信息。
生成 SCIM 终结点
现在你已设计了架构并了解了 Microsoft Entra SCIM 实施，可以开始开发 SCIM 终结点了。 可以依赖于由 SCIM 社区发布的许多开源 SCIM 库，而不必从头开始完全靠自己生成实现。
有关如何生成 SCIM 终结点的指南（内附示例），请参阅开发示例 SCIM 终结点。
Microsoft Entra 预配团队发布的开源 .NET Core 参考代码示例就是一种可助你立即开始开发的资源。 生成 SCIM 终结点，然后通过提供的示例请求/响应来测试它。
注意
该参考代码按“原样”提供，旨在帮助你开始生成 SCIM 终结点。我们欢迎社区供稿，以帮助构建和维护代码。
解决方案由两个项目组成：Microsoft.SCIM 和 Microsoft.SCIM.WebHostSample 。
Microsoft.SCIM 项目是一个库，用于定义符合 SCIM 规范的 Web 服务的组件。 该项目声明接口 Microsoft.SCIM.IProvider，请求被转换为对提供程序方法的调用，这些方法将经过编程，可对标识存储区进行操作。
Microsoft.SCIM.WebHostSample 项目是一个基于空模板的 ASP.NET Core Web 应用程序。 它使得示例代码可以进行独立部署以及托管在容器或 Internet Information Services 中。 该项目还实现 Microsoft.SCIM.IProvider 接口，将类保留在内存中作为示例标识存储。
public class Startup
{
...
public IMonitor MonitoringBehavior { get; set; }
public IProvider ProviderBehavior { get; set; }
public Startup(IWebHostEnvironment env, IConfiguration configuration)
{
...
this.MonitoringBehavior = new ConsoleMonitor();
this.ProviderBehavior = new InMemoryProvider();
}
...
生成自定义 SCIM 终结点
SCIM 终结点必须具有 HTTP 地址和服务器身份验证证书，其中的根证书颁发机构为下列其中之一：
- CNNIC
- Comodo
- CyberTrust
- DigiCert
- GeoTrust
- GlobalSign
- Go Daddy
- VeriSign
- WoSign
- DST 根 CA X3
.NET Core SDK 包含开发期间使用的 HTTPS 开发证书。 该证书是作为首次运行体验的一部分安装的。 根据你运行 ASP.NET Core Web 应用程序的方式，它侦听其他端口：
- Microsoft.SCIM.WebHostSample：
https://localhost:5001 - IIS Express：
https://localhost:44359
有关 ASP.NET Core 中 HTTPS 的详细信息，请使用以下链接：在 ASP.NET Core 中强制使用 HTTPS
处理终结点身份验证
来自 Microsoft Entra 预配服务的请求包括 OAuth 2.0 持有者令牌。 授权服务器颁发持有者令牌。 Microsoft Entra ID 是受信任的授权服务器的一个示例。 将 Microsoft Entra 预配服务配置为使用以下令牌之一：
长期持有者令牌。 如果 SCIM 终结点需要来自非 Microsoft Entra ID 颁发者的 OAuth 持有者令牌，可将所需的 OAuth 持有者令牌复制到可选的“机密令牌”字段。 在开发环境中，可以从
/scim/token终结点使用测试令牌。 不应在生产环境中使用测试令牌。Microsoft Entra 持有者令牌。 如果“机密令牌”字段留空，则 Microsoft Entra ID 会在每个请求中包含从 Microsoft Entra ID 颁发的 OAuth 持有者令牌。 使用 Microsoft Entra ID 作为标识提供者的应用可以验证此 Microsoft Entra ID 颁发的令牌。
- 接收请求的应用程序应验证令牌颁发者是否为预期 Microsoft Entra 租户的 Microsoft Entra ID。
iss声明标识令牌的颁发者。 例如"iss":"https://sts.windows.net/aaaabbbb-0000-cccc-1111-dddd2222eeee/"。 在此示例中，声明值的基址https://sts.windows.net将 Microsoft Entra ID 标识为颁发者，而相对地址段 aaaabbbb-0000-cccc-1111-dddd2222eeee 是获得令牌的 Microsoft Entra 租户的唯一标识符。- 令牌的受众是库中应用程序的“应用程序 ID”。 在单个租户中注册的应用程序使用 SCIM 请求接收相同的
iss声明。 所有自定义应用的应用程序 ID 都是 8adf8e6e-67b2-4cf2-a259-e3dc5476c621。 Microsoft Entra ID 生成的令牌仅应用于测试。 它不应在生产环境中使用。
在示例代码中，使用 Microsoft.AspNetCore.Authentication.JwtBearer 包对请求进行身份验证。 以下代码强制使用由指定租户的 Microsoft Entra ID 颁发的持有者令牌来验证对任何服务终结点的请求：
public void ConfigureServices(IServiceCollection services)
{
if (_env.IsDevelopment())
{
...
}
else
{
services.AddAuthentication(options =>
{
options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
})
.AddJwtBearer(options =>
{
options.Authority = " https://sts.windows.net/aaaabbbb-0000-cccc-1111-dddd2222eeee/";
options.Audience = "8adf8e6e-67b2-4cf2-a259-e3dc5476c621";
...
});
}
...
}
public void Configure(IApplicationBuilder app)
{
...
app.UseAuthentication();
app.UseAuthorization();
...
}
该示例代码使用 ASP.NET Core 环境在开发阶段更改身份验证选项并启用自签名令牌。
有关 ASP.NET Core 中多个环境的详细信息，请参阅在 ASP.NET Core 中使用多个环境。
以下代码强制使用通过自定义密钥签名的持有者令牌来验证对任何服务终结点的请求：
public void ConfigureServices(IServiceCollection services)
{
if (_env.IsDevelopment())
{
services.AddAuthentication(options =>
{
options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
})
.AddJwtBearer(options =>
{
options.TokenValidationParameters =
new TokenValidationParameters
{
ValidateIssuer = false,
ValidateAudience = false,
ValidateLifetime = false,
ValidateIssuerSigningKey = false,
ValidIssuer = "Microsoft.Security.Bearer",
ValidAudience = "Microsoft.Security.Bearer",
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("A1B2C3D4E5F6A1B2C3D4E5F6"))
};
});
}
...
向令牌控制器发送 GET 请求以获取有效的持有者令牌，方法 GenerateJSONWebToken 负责创建与配置用于开发的参数匹配的令牌：
private string GenerateJSONWebToken()
{
// Create token key
SymmetricSecurityKey securityKey =
new SymmetricSecurityKey(Encoding.UTF8.GetBytes("A1B2C3D4E5F6A1B2C3D4E5F6"));
SigningCredentials credentials =
new SigningCredentials(securityKey, SecurityAlgorithms.HmacSha256);
// Set token expiration
DateTime startTime = DateTime.UtcNow;
DateTime expiryTime = startTime.AddMinutes(120);
// Generate the token
JwtSecurityToken token =
new JwtSecurityToken(
"Microsoft.Security.Bearer",
"Microsoft.Security.Bearer",
null,
notBefore: startTime,
expires: expiryTime,
signingCredentials: credentials);
string result = new JwtSecurityTokenHandler().WriteToken(token);
return result;
}
处理用户预配和取消预配
示例 1.查询服务以找到匹配的用户
Microsoft Entra ID 会在服务中查询是否有某个用户的 externalId 特性值与 Microsoft Entra ID 中用户的 mailNickname 特性值匹配。 查询以类似此例的超文本传输协议 (HTTP) 请求形式表示，其中，jyoung 是 Microsoft Entra 中某个用户的 mailNickname 示例。
注意
这只是一个示例。 并非所有用户都具有 mailNickname 属性，并且该用户具有的值可能不是目录中的唯一值。 另外，用于匹配的特性（在本例中为 externalId）可以在 Microsoft Entra 特性映射中进行配置。
GET https://.../scim/Users?filter=externalId eq jyoung HTTP/1.1
Authorization: Bearer ...
在示例代码中，请求被转换为对服务提供程序的 QueryAsync 方法的调用。 以下是该方法的签名：
// System.Threading.Tasks.Tasks is defined in mscorlib.dll.
// Microsoft.SCIM.IRequest is defined in
// Microsoft.SCIM.Service.
// Microsoft.SCIM.Resource is defined in
// Microsoft.SCIM.Schemas.
// Microsoft.SCIM.IQueryParameters is defined in
// Microsoft.SCIM.Protocol.
Task<Resource[]> QueryAsync(IRequest<IQueryParameters> request);
在示例查询中，对于具有 externalId 属性的给定值的用户，传递给 QueryAsync 方法的参数的值为：
- parameters.AlternateFilters.Count:1
- parameters.AlternateFilters.ElementAt(0).AttributePath: "externalId"
- parameters.AlternateFilters.ElementAt(0).ComparisonOperator:ComparisonOperator.Equals
- parameters.AlternateFilter.ElementAt(0).ComparisonValue: "jyoung"
示例 2.预配用户
如果查询 SCIM 终结点是否有某个用户的 externalId 特性值与用户的 mailNickname 特性值匹配时，该查询的响应未返回任何用户，Microsoft Entra ID 将请求服务预配一个与 Microsoft Entra ID 中的用户相对应的用户。 以下是此类请求的示例：
POST https://.../scim/Users HTTP/1.1
Authorization: Bearer ...
Content-type: application/scim+json
{
"schemas":
[
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0User"],
"externalId":"jyoung",
"userName":"jyoung@testuser.com",
"active":true,
"addresses":null,
"displayName":"Joy Young",
"emails": [
{
"type":"work",
"value":"jyoung@Contoso.com",
"primary":true}],
"meta": {
"resourceType":"User"},
"name":{
"familyName":"Young",
"givenName":"Joy"},
"phoneNumbers":null,
"preferredLanguage":null,
"title":null,
"department":null,
"manager":null}
在示例代码中，请求被转换为对服务提供程序的 CreateAsync 方法的调用。 以下是该方法的签名：
// System.Threading.Tasks.Tasks is defined in mscorlib.dll.
// Microsoft.SCIM.IRequest is defined in
// Microsoft.SCIM.Service.
// Microsoft.SCIM.Resource is defined in
// Microsoft.SCIM.Schemas.
Task<Resource> CreateAsync(IRequest<Resource> request);
在用户预配请求中，资源参数的值是 Microsoft.SCIM.Core2EnterpriseUser 类的实例。 此类在 Microsoft.SCIM.Schemas 库中定义。 如果预配用户的请求成功，则方法的实现应返回 Microsoft.SCIM.Core2EnterpriseUser 类的实例。 Identifier 属性的值设置为新预配用户的唯一标识符。
示例 3.查询用户的当前状态
Microsoft Entra ID 通过如下请求从服务请求指定用户的当前状态：
GET ~/scim/Users/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 HTTP/1.1
Authorization: Bearer ...
在示例代码中，请求被转换为对服务提供程序的 RetrieveAsync 方法的调用。 以下是该方法的签名：
// System.Threading.Tasks.Tasks is defined in mscorlib.dll.
// Microsoft.SCIM.IRequest is defined in
// Microsoft.SCIM.Service.
// Microsoft.SCIM.Resource and
// Microsoft.SCIM.IResourceRetrievalParameters
// are defined in Microsoft.SCIM.Schemas
Task<Resource> RetrieveAsync(IRequest<IResourceRetrievalParameters> request);
在检索用户当前状态的请求示例中，作为参数自变量值提供的对象属性值如下所示：
- 标识符：“a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1”
- SchemaIdentifier：
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
示例 4.查询要更新的引用属性的值
更新之前，Microsoft Entra ID 会检查标识存储中的当前属性值。 但是，首先会检查用户的管理员属性。 以下请求示例将确定用户对象的 manager 特性当前是否具有特定值：在示例代码中，请求被转换为对服务提供程序的 QueryAsync 方法的调用。 作为参数自变量值提供的对像属性值如下：
- parameters.AlternateFilters.Count:2
- parameters.AlternateFilters.ElementAt(x).AttributePath:“ID”
- parameters.AlternateFilters.ElementAt(x).ComparisonOperator:ComparisonOperator.Equals
- parameters.AlternateFilter.ElementAt(x).ComparisonValue：“a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1”
- parameters.AlternateFilters.ElementAt(y).AttributePath: "manager"
- parameters.AlternateFilters.ElementAt(y).ComparisonOperator:ComparisonOperator.Equals
- parameters.AlternateFilter.ElementAt(y).ComparisonValue: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
- parameters.RequestedAttributePaths.ElementAt(0):“ID”
- parameters.SchemaIdentifier：
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
索引 x 的值可以是 0，索引 y 的值可以是 1。 或者 x 的值可以是 1，y 的值可以是 0。 这取决于筛选器查询参数的表达式顺序。
示例 5. 从 Microsoft Entra ID 向 SCIM 终结点发出更新用户请求
下面是从 Microsoft Entra ID 向 SCIM 终结点发出更新用户请求的示例：
PATCH ~/scim/Users/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 HTTP/1.1
Authorization: Bearer ...
Content-type: application/scim+json
{
"schemas":
[
"urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations":
[
{
"op":"Add",
"path":"manager",
"value":
[
{
"$ref":"http://.../scim/Users/00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"value":"00aa00aa-bb11-cc22-dd33-44ee44ee44ee"}]}]}
在示例代码中，请求被转换为对服务提供程序的 UpdateAsync 方法的调用。 以下是该方法的签名：
// System.Threading.Tasks.Tasks and
// System.Collections.Generic.IReadOnlyCollection<T> // are defined in mscorlib.dll.
// Microsoft.SCIM.IRequest is defined in
// Microsoft.SCIM.Service.
// Microsoft.SCIM.IPatch,
// is defined in Microsoft.SCIM.Protocol.
Task UpdateAsync(IRequest<IPatch> request);
在更新用户的请求示例中，作为补丁参数值提供的对象具有这些属性值：
| 参数 | 值 |
|---|---|
ResourceIdentifier.Identifier |
“a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1” |
ResourceIdentifier.SchemaIdentifier |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User |
(PatchRequest as PatchRequest2).Operations.Count |
1 |
(PatchRequest as PatchRequest2).Operations.ElementAt(0).OperationName |
OperationName.Add |
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Path.AttributePath |
Manager |
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Value.Count |
1 |
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Value.ElementAt(0).Reference |
http://.../scim/Users/00aa00aa-bb11-cc22-dd33-44ee44ee44ee |
(PatchRequest as PatchRequest2).Operations.ElementAt(0).Value.ElementAt(0).Value |
00aa00aa-bb11-cc22-dd33-44ee44ee44ee |
示例6.取消预配用户
若要从前端为 SCIM 终结点的标识存储区中取消预配用户，Microsoft Entra ID 会发送如下请求：
DELETE ~/scim/Users/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1 HTTP/1.1
Authorization: Bearer ...
在示例代码中，请求被转换为对服务提供程序的 DeleteAsync 方法的调用。 以下是该方法的签名：
// System.Threading.Tasks.Tasks is defined in mscorlib.dll.
// Microsoft.SCIM.IRequest is defined in
// Microsoft.SCIM.Service.
// Microsoft.SCIM.IResourceIdentifier,
// is defined in Microsoft.SCIM.Protocol.
Task DeleteAsync(IRequest<IResourceIdentifier> request);
在取消预配用户的请求示例中，作为 resourceIdentifier 参数值提供的对象具有以下属性值：
- ResourceIdentifier.Identifier：“a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1”
- ResourceIdentifier.SchemaIdentifier：
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
将 SCIM 终结点与 Microsoft Entra 预配服务集成
可以将 Microsoft Entra ID 配置为自动将分配的用户和组预配给实施 SCIM 2.0 协议的特定配置文件的应用程序。 配置文件的详细信息在了解 Microsoft Entra SCIM 实施中有所介绍。
请咨询应用程序提供者，或参阅应用程序提供者文档中的说明，以了解是否符合这些要求。
重要
Microsoft Entra SCIM 实施基于 Microsoft Entra 用户预配服务构建，旨在使用户在 Microsoft Entra ID 与目标应用程序之间持续保持同步，并实施一组非常具体的标准操作。 请务必了解这些行为，这样才能了解 Microsoft Entra 预配服务的行为。 有关详细信息，请参阅预配工作原理中的预配周期：初始和增量部分。
使用入门
提示
本文中的步骤可能因开始使用的门户而略有不同。
支持本文所述 SCIM 配置文件的应用程序可以使用 Microsoft Entra 应用程序库中的“非库应用程序”功能连接到 Microsoft Entra ID。 连接后，Microsoft Entra ID 将运行同步过程。 此过程每隔 40 分钟运行一次。 此过程将为分配的用户和组查询应用程序的 SCIM 终结点，并根据分配详细信息创建或修改这些用户和组。
连接到支持 SCIM 的应用程序：
至少以应用程序管理员的身份登录到 Microsoft Entra 管理中心。
浏览到“标识”>“应用程序”>“企业应用程序”。
系统显示所有已配置的应用（包括从库中添加的应用）的列表。
选择“+新建应用程序”>“+创建自己的应用程序” 。
输入应用程序的名称，选择“集成在库中找不到的任何其他应用程序”选项，然后选择“添加”来创建应用对象。 新的应用将添加到企业应用程序列表中，并在应用管理屏幕中打开。
以下屏幕截图显示 Microsoft Entra 应用程序库：
在应用管理屏幕的左侧面板中，选择“预配”。
在“预配模式”菜单中，选择“自动” 。
以下屏幕截图显示 Microsoft Entra 管理中心中正在配置的预配设置：
在“租户 URL”字段中，输入应用程序的 SCIM 终结点的 URL。 示例：
https://api.contoso.com/scim/如果 SCIM 终结点需要来自非 Microsoft Entra ID 颁发者的 OAuth 持有者令牌，可将所需的 OAuth 持有者令牌复制到可选的“机密令牌”字段。 如果此字段留空，则 Microsoft Entra ID 会在每个请求中包含从 Microsoft Entra ID 颁发的 OAuth 持有者令牌。 使用 Microsoft Entra ID 作为标识提供者的应用可以验证此 Microsoft Entra ID 颁发的令牌。
注意
建议不要将此字段留空并依赖 Microsoft Entra ID 生成的令牌*。 此选项主要用于测试目的。
选择“测试连接”，使 Microsoft Entra ID 尝试连接到 SCIM 终结点。 如果尝试失败，则显示错误信息。
注意
测试连接使用随机 GUID 作为在 Microsoft Entra 配置中选择的匹配属性，针对不存在的用户查询 SCIM 终结点。 预期正确响应为“HTTP 200 正常”以及空的 SCIM ListResponse 消息。
如果尝试连接应用程序成功，请选择“保存”以保存管理员凭据。
在“映射”部分中有两个可选的属性映射集：一个用于用户对象，一个用于组对象。 分别选择它们，查看从 Microsoft Entra ID 同步到应用的特性。 选为“匹配”属性的特性用于匹配应用中的用户和组，以执行更新操作。 选择“保存”，提交所有更改。
注意
也可通过禁用“组”映射来选择性禁用组对象的同步。
“设置”下的“作用域”字段定义同步的用户和组 。 选择“仅同步分配的用户和组”（推荐），以便仅同步“用户和组”选项卡中分配的用户和组 。
配置完成后，请将“预配状态”设置为“启用” 。
选择“保存”以启用 Microsoft Entra 预配服务。
如果仅同步分配的用户和组（推荐），请选择“用户和组”选项卡。然后分配要同步的用户或组。
初始周期开始后，可以在左侧面板中选择“预配日志”来监视进度，该日志会显示预配服务在应用上执行的所有操作。 要详细了解如何读取 Microsoft Entra 预配日志，请参阅有关自动用户帐户预配的报告。
注意
初始周期执行的时间比后续同步长，只要服务正在运行，大约每隔 40 分钟就会进行一次同步。
在 Microsoft Entra 应用程序库中发布应用程序
如果要构建由多个租户使用的应用程序，请将其置于 Microsoft Entra 应用程序库。 组织就可以轻松发现应用程序和配置预配。 轻松地在 Microsoft Entra 库中发布应用并将预配提供给其他人。 在此处查看步骤。 Microsoft 会与你合作，将应用程序集成到库中、测试终结点，并发布加入文档供客户使用。
库上架清单
请使用清单，使应用程序快速上架，让客户享受顺畅的部署体验。 当加入到库时，系统会向你收集相关信息。
- 支持 SCIM 2.0 用户和组终结点（仅需要其中一项支持，但建议同时确保这两项支持）
- 支持每个租户每秒至少 25 个请求，以确保预配和取消预配用户和组时不会出现延迟（必需）
- 确定工程和支持联系人，以便在上架到库后为客户提供指导（必需）
- 3 个应用程序的未过期测试凭据（必需）
- 如示例中所述，支持 OAuth 授权代码许可或长期有效的令牌（必需）
- OIDC 应用必须至少定义 1 个角色（自定义或默认）
- 建立工程和支持联系点，以便在上架到库后为客户提供支持（必需）
- 支持架构发现（必需）
- 支持使用单个 PATCH 更新多个组成员身份
- 公开记录 SCIM 终结点
用于在应用程序库中预配连接器的授权
SCIM 规范未定义用于身份验证和授权的特定于 SCIM 的方案，并依赖于现有行业标准。
| 授权方法 | 优点 | 缺点 | 支持 |
|---|---|---|---|
| 用户名和密码（Microsoft Entra ID 不推荐或不支持） | 易于实现 | 不安全 - 你的密码无关紧要 | 新库或非库应用不支持。 |
| 长期持有者令牌 | 长期令牌不要求用户提供此令牌。 管理员在设置预配时可以轻松地使用这些令牌。 | 如果不使用电子邮件等不安全的方法，则很难与管理员共享长期令牌。 | 库应用和非库应用均支持。 |
| OAuth 授权代码许可 | 访问令牌的生存期比密码更短，并且具有长期持有者令牌不具有的自动刷新机制。 初次授权时，真实用户必须提供该令牌，从而增加了责任级别。 | 要求用户提供。 如果用户离开组织，则令牌无效，并且需要再次完成授权。 | 库应用支持，但非库应用不支持。 但是，可以在 UI 中提供一个访问令牌作为短期测试的机密令牌。 我们已计划支持对非库授予的 OAuth 代码，并支持库应用上的可配置身份验证/标记 URL。 |
| OAuth 客户端凭据许可 | 访问令牌的生存期比密码更短，并且具有长期持有者令牌不具有的自动刷新机制。 授权代码许可和客户端凭据许可都创建相同类型的访问令牌，因此换用这些方法对 API 是透明的。 预配可以自动执行，无需用户干预即可以无提示的方式请求提供新令牌。 | 库应用支持，但非库应用不支持。 但是，可以在 UI 中提供一个访问令牌作为短期测试的机密令牌。 积压工作 (backlog) 中支持对非库的 OAuth 客户端凭据授权。 |
注意
不建议在 Microsoft Entra 预配配置自定义应用 UI 中将令牌字段留空。 生成的令牌主要用于测试目的。
OAuth 代码授予流
预配服务支持授权代码授予，在提交了在库中发布应用的请求后，我们的团队将与你合作收集以下信息：
授权 URL，这是客户端通过用户代理重定向从资源所有者获得授权时所使用的 URL。 将用户重定向到此 URL 以授予访问权限。
令牌交换 URL，这是客户端通常通过客户端身份验证来交换访问令牌的授权许可时所使用的 URL。
客户端 ID，这是授权服务器向注册的客户端发出客户端标识符，该客户端标识符是表示客户端提供的注册信息的唯一字符串。 客户端标识符不是机密；它向资源所有者公开，并且不得单独用于客户端身份验证。
客户端密码，这是授权服务器生成的机密，应该是只有授权服务器才知道的唯一值。
注意
授权 URL 和令牌交换 URL 当前为每位租户进行配置 。
注意
由于公开了客户端密码，因此 OAuth v1 不受支持。 OAuth v2 受支持。
使用 OAuth 代码授予流时，需要支持一个模型，其中每个客户在设置预配实例时将提交自己的客户端 ID 和客户端密码。 不支持单个应用范围的客户端 ID/客户端密码对。
如何设置 OAuth 代码授权流
至少以应用程序管理员的身份登录到 Microsoft Entra 管理中心。
浏览到“标识”>“应用程序”>“企业应用程序”>“应用程序”>“预配”，然后选择“授权”。
至少以应用程序管理员的身份登录到 Microsoft Entra 管理中心。
浏览到“标识”>“应用程序”>“企业应用程序”。
选择应用程序，然后转到“预配”。
选择“授权”。
用户将重定向到“授权 URL”（第三方应用的登录页面）。
管理员向第三方应用程序提供凭据。
第三方应用将重定向回用户，并提供授权代码
预配服务将调用令牌 URL 并提供授权代码。 第三方应用程序以访问令牌、刷新令牌和到期日期做出响应
预配周期开始时，服务会检查当前访问令牌是否有效，并根据需要替换为新令牌。 每次向应用发出请求时提供访问令牌，并在每次请求前检查请求的有效性。
注意
虽然不能在非库应用程序上设置 OAuth，但可以手动从授权服务器生成访问令牌，并将其作为机密令牌输入到非库应用程序中。 这样，你就可以在加入应用库之前验证 SCIM 服务器与 Microsoft Entra 预配服务的兼容性，从而支持 OAuth 代码授权。
OAuth 长期持有者令牌：如果应用程序不支持 OAuth 授权代码许可流，可改为生成 OAuth 长期持有者令牌，管理员可以使用该令牌来设置预配集成。 该令牌应永不过期，否则当令牌过期时，预配作业会被隔离。
有关更多身份验证和授权方法，请在 UserVoice 上告诉我们。
库上市投放检查列表
为了帮助提高联合集的认知度和需求，我们建议你更新现有文档并更加详细地说明营销渠道中的集成。 建议完成以下检查列表，为启动工作提供支持：
- 确保销售团队和客户支持团队了解集成功能，已做好准备并能够进行适当宣传。 向团队介绍简要情况，向他们提供常见问题解答，并将集成添加到销售材料中。
- 撰写介绍联合集成、优点以及入门方法的博客文章或新闻稿。 示例：Imprivata 和 Microsoft Entra 新闻稿
- 利用社交媒体（例如 X、Facebook 或 LinkedIn）向客户推广集成。 请确保包含 @Microsoft Entra ID，以便我们能够转推你的帖子。 示例：Imprivata X 贴文
- 创建或更新营销页面/网站（例如集成页面、合作伙伴页面、定价页面等），以包括联合集成的供应情况。 示例：Pingboard 集成页面、Smartsheet 集成页面和 Monday.com 定价页面
- 创建有关客户如何入门的帮助中心文章或技术文档。 示例：Envoy + Microsoft Entra 集成。
- 通过客户通信（每月简讯、电子邮件活动、产品发行说明）提醒客户有新的集成。