Visão Geral

O protocolo SCIM é um protocolo baseado em HTTP para provisionamento e gerenciamento de dados de identidade especificados através de esquemas SCIM. Você pode usar o Casdoor como um provedor de serviço SCIM.

Utilize o Casdoor como provedor de serviço SCIM

Atualmente, o Casdoor suporta apenas User Resource Schema, você pode gerenciar usuários através das operações de Usuário SCIM. Você pode interagir com o Casdoor através dos seguintes endpoints:

Endpoint	Método	Descrição
/scim/ServiceProviderConfig	GET	Forneça detalhes sobre os recursos do padrão SCIM que são suportados, por exemplo, os recursos que são suportados.
/scim/Schemas	GET	Forneça detalhes sobre os esquemas do provedor de serviço.
/scim/ResourceTypes	GET	Especifique metadados sobre cada recurso.
/scim/Users/:id	GET	Recupere um usuário com identificador de recurso id.
/scim/Users	GET	Consulte usuários com parâmetros de consulta (atualmente suporta apenas startIndex e count).
/scim/Users	POST	Crie um usuário.
/scim/Users/:id	PUT	Atualize um usuário com identificador de recurso id.
/scim/Users/:id	PATCH	Modifique um usuário com identificador de recurso id por operação PATCH.
/scim/Users/:id	DEL	Exclua um usuário com identificador de recurso id.

Para mais detalhes, por favor, consulte rfc7644.

Recurso de Usuário

O Casdoor implementa o mapeamento entre User Resource Schema (SCIM) e User (Casdoor). A relação de mapeamento entre atributos é a seguinte:

User Resource Schema (SCIM)	Usuário (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

Como o Casdoor usa Organização para gerenciar Usuário, onde cada Usuário pertence a uma Organização específica, o atributo organization deve ser passado em Enterprise User Schema Extension (identificado pelo URI do esquema urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). Aqui está uma representação em formato JSON do User Resource Schema SCIM:

{
    "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"
}