> 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/jp/idoyobiakusesuiam/apidokyumento-scim/jian-chu-api/sukma.md).

# スキーマ

### 概要

この `/Schemas` このエンドポイントは、このSCIMサービスでサポートされているスキーマ定義を返します。

これは次を説明します:

* 利用可能なリソース（例: User）
* 各リソース内の属性
* 属性の種類と制約

IDプロバイダーはこのエンドポイントを次の目的で使用します:

* リクエスト/レスポンスの構造を検証する
* システム間で属性をマッピングする
* プロビジョニングの動作を構成する

***

### エンドポイント

```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": "User",
        "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": "User",
    "description": "ユーザーアカウント",
    "attributes": [
      {
        "name": "userName",
        "type": "文字列",
        "multiValued": false,
        "required": true,
        "caseExact": false,
        "mutability": "読み書き可",
        "returned": "default",
        "uniqueness": "server"
      },
      {
        "name": "externalId",
        "type": "文字列",
        "multiValued": false,
        "required": false,
        "mutability": "読み書き可",
        "returned": "default",
        "uniqueness": "server"
      },
      {
        "name": "displayName",
        "type": "文字列",
        "multiValued": false,
        "required": false,
        "mutability": "読み書き可",
        "returned": "default"
      },
      {
        "name": "active",
        "type": "真偽値",
        "multiValued": false,
        "required": false,
        "mutability": "読み書き可",
        "returned": "default"
      },
      {
        "name": "emails",
        "type": "複合",
        "multiValued": false,
        "required": true,
        "mutability": "読み書き可",
        "returned": "default",
        "subAttributes": [
          {
            "name": "value",
            "type": "文字列",
            "required": true
          },
          {
            "name": "primary",
            "type": "真偽値"
          }
        ]
      },
      {
        "name": "roles",
        "type": "複合",
        "multiValued": false,
        "required": true,
        "mutability": "読み書き可",
        "returned": "default",
        "subAttributes": [
          {
            "name": "value",
            "type": "文字列",
            "required": true
          }
        ]
      },
      {
        "name": "name",
        "type": "複合",
        "multiValued": false,
        "required": false,
        "subAttributes": [
          {
            "name": "givenName",
            "type": "文字列"
          },
          {
            "name": "familyName",
            "type": "文字列"
          }
        ]
      }
    ]
  },
  "message": "成功"
}
```

***

## 属性フィールドの説明

<table><thead><tr><th width="167">フィールド</th><th>説明</th></tr></thead><tbody><tr><td>name</td><td>属性名</td></tr><tr><td>type</td><td>データ型（文字列、真偽値、複合）</td></tr><tr><td>required</td><td>属性が必須かどうか</td></tr><tr><td>multiValued</td><td>配列値を示します</td></tr><tr><td>mutability</td><td>読み取り専用 / 読み書き可</td></tr><tr><td>uniqueness</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          | ユーザーステータス |