> 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/yzapi.md).

# ユーザーAPI

### 概要

この `/Users` このエンドポイントは、システム内のユーザーIDを管理するために使用されます。

ユーザーのライフサイクル全体をサポートし、次を含みます:

* ユーザーの作成
* ユーザー情報の取得
* ユーザー属性の更新
* ユーザーの削除

Okta や Microsoft Azure Active Directory などの ID プロバイダーは、自動プロビジョニングおよびデプロビジョニングにこのエンドポイントを使用します。

***

### ベースエンドポイント

```http
https://api.ggwp.com/scim/v2/Users
```

***

### サポートされる操作

| 操作           | メソッド   | エンドポイント       |
| ------------ | ------ | ------------- |
| ユーザーを作成      | POST   | `/Users`      |
| ユーザーを取得      | GET    | `/Users/{id}` |
| ユーザーのPATCH更新 | PATCH  | `/Users/{id}` |
| ユーザーを削除      | DELETE | `/Users/{id}` |

***

### リソース識別子

各ユーザーは次の要素で一意に識別されます:

* `id` → システム生成の一意の識別子
* `userName` → 一意のユーザー名（IdPで使用）
* `email` → 一意のメールアドレス

***

### リクエストとレスポンスの形式

すべてのリクエストとレスポンスは次を満たす必要があります:

* 次を含める `schemas` 属性が含まれます
* SCIM 2.0 標準に従う

***

### 属性

<table><thead><tr><th width="179.5">属性</th><th>説明</th></tr></thead><tbody><tr><td>id</td><td>一意の識別子</td></tr><tr><td>userName</td><td>一意のユーザー名</td></tr><tr><td>emails</td><td>ユーザーのメールアドレス</td></tr><tr><td>name</td><td>ユーザーの名前オブジェクト</td></tr><tr><td>active</td><td>ユーザーがアクティブかどうかを示します（未使用）</td></tr></tbody></table>