Обзор

Протокол SCIM - это HTTP-протокол для управления и предоставления данных идентификации, определенный через схемы SCIM. Вы можете использовать Casdoor в качестве поставщика услуг SCIM.

Использование Casdoor в качестве поставщика услуг SCIM

В настоящее время Casdoor поддерживает только User Resource Schema, вы можете управлять пользователями через операции SCIM User. Вы можете взаимодействовать с Casdoor через следующие конечные точки:

Конечная точка	Метод	Описание
/scim/ServiceProviderConfig	GET	Предоставьте детали о функциях стандарта SCIM, которые поддерживаются, например, о поддерживаемых ресурсах.
/scim/Schemas	GET	Предоставьте детали о схемах поставщика услуг.
/scim/ResourceTypes	GET	Укажите метаданные о каждом ресурсе.
/scim/Users/:id	GET	Получить пользователя с идентификатором ресурса id.
/scim/Users	GET	Запросить пользователей с параметрами запроса (в настоящее время поддерживаются только startIndex и count).
/scim/Users	POST	Создать пользователя.
/scim/Users/:id	PUT	Обновить пользователя с идентификатором ресурса id.
/scim/Users/:id	PATCH	Изменить пользователя с идентификатором ресурса id с помощью операции PATCH.
/scim/Users/:id	DEL	Удалить пользователя с идентификатором ресурса id.

Для получения дополнительной информации, пожалуйста, обратитесь к rfc7644.

Ресурс Пользователя

Casdoor реализует сопоставление между User Resource Schema (SCIM) и User (Casdoor). Отношение сопоставления атрибутов следующее:

Схема Ресурса Пользователя (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 использует Организацию для управления Пользователем, где каждый Пользователь принадлежит к определенной Организации, атрибут organization должен быть передан в Enterprise User Schema Extension (идентифицируется по URI схемы urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). Вот представление Схемы Ресурса Пользователя 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"
}