概述

SCIM 是基于 HTTP 的身份数据预配和管理标准。 Casdoor 可以充当 SCIM 服务提供商，外部系统可以通过 SCIM 创建、读取、更新和删除用户。

支持的资源

Casdoor 支持 User 和 Group 两种资源。用以下接口管理它们：

端点	方法	描述
/scim/ServiceProviderConfig	GET	支持的 SCIM 功能和资源
/scim/Schemas	GET	服务提供商的 schema
/scim/ResourceTypes	GET	资源类型元数据
/scim/Users/:id	GET	按 id 获取用户
/scim/Users	GET	列出用户（查询参数：startIndex、count）
/scim/Users	POST	创建用户
/scim/Users/:id	PUT	替换用户
/scim/Users/:id	PATCH	部分更新
/scim/Users/:id	DELETE	删除用户
/scim/Groups/:id	GET	按 id 获取群组
/scim/Groups	GET	列出群组（查询参数：startIndex、count）
/scim/Groups	POST	创建群组
/scim/Groups/:id	PUT	替换群组
/scim/Groups/:id	PATCH	部分更新
/scim/Groups/:id	DELETE	删除群组

完整的 SCIM 规范见 RFC 7644。

用户属性映射

SCIM User 属性与 Casdoor User 字段的对应关系如下：

用户资源模式（SCIM）	用户（Casdoor）
id	Id
meta.created	CreatedTime
meta.lastModified	UpdatedTime
meta.version	UpdatedTime
externalId	ExternalId
userName	Name
password	Password
displayName	DisplayName
profileUrl	Homepage
userType	Type
name.givenName	FirstName
name.familyName	LastName
emails[0].value	Email
phoneNumbers[0].value	Phone
photos[0].value	Avatar
addresses[0].locality	Location
addresses[0].region	Region
addresses[0].country	CountryCode

由于Casdoor使用组织来管理用户，每个用户都属于特定的组织，所以应该在Enterprise User Schema Extension（由模式URI urn:ietf:params:scim:schemas:extension:enterprise:2.0:User标识）中传递organization属性。以下是用户资源模式SCIM在JSON格式中的表示：

{
    "active": true,
    "addresses": [
        {
            "country": "CN",
            "locality": "Shanghai",
            "region": "CN"
        }
    ],
    "displayName": "Bob~",
    "emails": [
        {
            "value": "test1@casdoor.com"
        }
    ],
    "externalId": "1234123543234234",
    "id": "ceacbcb6-40d0-48f1-af23-0990232d570a",
    "meta": {
        "resourceType": "User",
        "created": "2023-10-08T23:51:55+08:00",
        "lastModified": "2023-10-12T20:38:49+08:00",
        "location": "Users/ceacbcb6-40d0-48f1-af23-0990232d570a",
        "version": "2023-10-12T20:38:49+08:00"
    },
    "name": {
        "familyName": "bob",
        "formatted": "alice bob",
        "givenName": "alice"
    },
    "nickName": "Bob~",
    "phoneNumbers": [
        {
            "value": "18700006475"
        }
    ],
    "photos": [
        {
            "value": "https://cdn.casbin.org/img/casbin.svg"
        }
    ],
    "profileUrl": "https://test.com/profile/built-in/scim_test_user2",
    "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:enterprise:2.0:User": { // The enterprise User extension is identified using this schema URI
        "organization": "built-in" // This attribute MUST be passed
    },
    "userName": "scim_test_user2",
    "userType": "normal-user"
}