> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/chinese-simplified/shen-fen-yu-fang-wen-guan-li-iam/api-wen-dang-scim/fa-xian-api/mo-shi.md).

# 模式

### 概述

该 `/Schemas` 该端点返回此 SCIM 服务支持的架构定义。

它描述：

* 可用资源（例如，User）
* 每个资源中的属性
* 属性类型和限制

身份提供商使用此端点来：

* 验证请求/响应结构
* 在系统之间映射属性
* 配置预配行为

***

### 端点

```bash
GET /Schemas
GET /Schemas/{id}
```

***

### 完整 URL

```bash
https://api.ggwp.com/scim/v2/Schemas
https://api.ggwp.com/scim/v2/Schemas/{schemaId}
```

***

### 身份验证

需要 Bearer 令牌：

```http
Authorization: Bearer <access_token>
```

***

## 获取所有架构

### 示例请求

```bash
GET /Schemas
```

***

### 响应

```json
{
  "data": {
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 1,
    "Resources": [
      {
        "id": "urn:ietf:params:scim:schemas:core:2.0:User",
        "name": "用户",
        "description": "用户账户",
        "endpoint": "/Users",
        "schema": "urn:ietf:params:scim:schemas:core:2.0:User"
      }
    ]
  },
  "message": "成功"
}
```

***

## 根据 ID 获取架构

### 示例请求

```bash
GET /Schemas/urn:ietf:params:scim:schemas:core:2.0:User
```

***

### 响应

### 成功（200 OK）

```json
{
  "data": {
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
    "id": "urn:ietf:params:scim:schemas:core:2.0:User",
    "name": "用户",
    "description": "用户账户",
    "attributes": [
      {
        "name": "userName",
        "type": "string",
        "multiValued": false,
        "required": true,
        "caseExact": false,
        "mutability": "readWrite",
        "returned": "default",
        "uniqueness": "server"
      },
      {
        "name": "externalId",
        "type": "string",
        "multiValued": false,
        "required": false,
        "mutability": "readWrite",
        "returned": "default",
        "uniqueness": "server"
      },
      {
        "name": "displayName",
        "type": "string",
        "multiValued": false,
        "required": false,
        "mutability": "readWrite",
        "returned": "default"
      },
      {
        "name": "active",
        "type": "boolean",
        "multiValued": false,
        "required": false,
        "mutability": "readWrite",
        "returned": "default"
      },
      {
        "name": "emails",
        "type": "complex",
        "multiValued": false,
        "required": true,
        "mutability": "readWrite",
        "returned": "default",
        "subAttributes": [
          {
            "name": "value",
            "type": "string",
            "required": true
          },
          {
            "name": "primary",
            "type": "boolean"
          }
        ]
      },
      {
        "name": "roles",
        "type": "complex",
        "multiValued": false,
        "required": true,
        "mutability": "readWrite",
        "returned": "default",
        "subAttributes": [
          {
            "name": "value",
            "type": "string",
            "required": true
          }
        ]
      },
      {
        "name": "name",
        "type": "complex",
        "multiValued": false,
        "required": false,
        "subAttributes": [
          {
            "name": "givenName",
            "type": "string"
          },
          {
            "name": "familyName",
            "type": "string"
          }
        ]
      }
    ]
  },
  "message": "成功"
}
```

***

## 属性字段说明

<table><thead><tr><th width="167">字段</th><th>描述</th></tr></thead><tbody><tr><td>名称</td><td>属性名称</td></tr><tr><td>类型</td><td>数据类型（字符串、布尔、复合）</td></tr><tr><td>必填</td><td>该属性是否必需</td></tr><tr><td>多值</td><td>表示数组值</td></tr><tr><td>可变性</td><td>只读 / 读写</td></tr><tr><td>唯一性</td><td>服务器 / 无</td></tr></tbody></table>

***

## 支持的模式

### 用户架构

URN：

```json
urn:ietf:params:scim:schemas:core:2.0:User
```

***

### 关键属性

| 属性              | 描述     |
| --------------- | ------ |
| userName        | 唯一用户名  |
| name.givenName  | 名字     |
| name.familyName | 姓氏     |
| emails.value    | 电子邮件地址 |
| active          | 用户状态   |