> For the complete documentation index, see [llms.txt](https://docs.digitalhumans.jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digitalhumans.jp/itp-guide/api/users.md).

# ユーザー

組織へのユーザーの追加、ロールの割り当て、ユーザーの一覧、状態の変更を API で行えます。

コード例の `BASE_URL`・`headers`・`API_KEY` は、「[認証](https://docs.digitalhumans.jp/itp-guide/api/authentication.md)」のコード例で定義したものです。

## ロールの値

API で指定するロールの値と、権限名の対応は次のとおりです。各ロールでできることは「[ユーザーとロール](https://docs.digitalhumans.jp/itp-guide/initial-setup/users-and-roles.md)」をご覧ください。

| API の値       | 権限名                       |
| ------------ | ------------------------- |
| `ORG_ADMIN`  | Organization Admin（組織管理者） |
| `TEAM_ADMIN` | Team Admin（チーム管理者）        |
| `AUTHOR`     | Author（シナリオ作成者）           |
| `MANAGER`    | Manager（マネージャー）           |
| `USER`       | User（受講者）                 |

## エンドポイント一覧

| メソッド   | エンドポイント                  | 内容                                         |
| ------ | ------------------------ | ------------------------------------------ |
| `POST` | `/users/add`             | [組織にユーザーを追加する](#post-users-add)            |
| `GET`  | `/users/page/{page}`     | [組織のユーザーを一覧する](#get-users-page-page)       |
| `POST` | `/users/roles/assign`    | [ユーザーにロールを割り当てる](#post-users-roles-assign) |
| `PUT`  | `/users/{userID}/status` | [ユーザーの状態を変更する](#put-users-userid-status)   |
| `PUT`  | `/users/{userID}`        | [ユーザー情報を変更する](#put-users-userid)           |

すべてのエンドポイントは、APIキーが無効な場合に `401`（ボディは `error` キー）、レート制限を超えた場合に `429` を返します。詳しくは「[認証](https://docs.digitalhumans.jp/itp-guide/api/authentication.md)」「[レート制限](https://docs.digitalhumans.jp/itp-guide/api/rate-limits.md)」をご覧ください。

***

## 組織にユーザーを追加する <a href="#post-users-add" id="post-users-add"></a>

メールアドレスを指定して、1人以上のユーザーを組織に追加します。まだアカウントが無いユーザーには招待が送られます。

```
POST /users/add
```

### リクエストヘッダー

| ヘッダー            | 値                     | 必須 |
| --------------- | --------------------- | -- |
| `Authorization` | `Bearer your-api-key` | はい |
| `Content-Type`  | `application/json`    | はい |

### リクエストボディ

```json
{
  "emails": ["user1@example.com", "user2@example.com"],
  "roles": ["USER"],
  "silent_add": false
}
```

| フィールド        | 型                | 説明                                                                                | 必須  |
| ------------ | ---------------- | --------------------------------------------------------------------------------- | --- |
| `emails`     | string\[]（email） | 追加するメールアドレスの一覧。1件以上必要                                                             | はい  |
| `roles`      | string\[]        | 割り当てるロール。値は `ORG_ADMIN`、`TEAM_ADMIN`、`AUTHOR`、`MANAGER`、`USER`                    | はい  |
| `silent_add` | boolean          | `true` にすると、ユーザーをデータベースに追加するだけで、Auth0（サインイン基盤）の招待メールを送りません。一括登録に便利です。既定値は `false` | いいえ |

{% hint style="warning" %}
**`roles` は追加ではなく、まるごと置き換えです。**\
呼び出すたびに、ユーザーの既存のロールは指定した内容で上書きされます。ロールを追加するときは、既存のロールに新しいロールを加えたものをすべて指定してください。\
例: 受講者の権限を残したままマネージャーにするには `["USER", "MANAGER"]` を指定します。`["MANAGER"]` だけを指定すると `USER` ロールが外れます。
{% endhint %}

{% hint style="success" %}
**1回あたりの件数**\
`emails` 配列の件数に厳密な上限はありません。ただし、メールアドレスは1件ずつ順に処理される（1件ごとにデータベースのトランザクション1回と Auth0 の呼び出し1回）ため、件数が非常に多いとリクエストがタイムアウトするおそれがあり、APIキーごとの[レート制限](https://docs.digitalhumans.jp/itp-guide/api/rate-limits.md)の枠も消費します。応答時間を安定させるため、**1リクエストあたり 100 件以下**をおすすめします。リクエストボディ自体の上限は、基盤の入口で 20 MB です。
{% endhint %}

{% hint style="info" %}
受講者は社員番号や仮名でも登録できます。氏名を登録する必要はありません。
{% endhint %}

### レスポンス

**200 OK**（全員の追加に成功）

```json
{
  "total_count": 2,
  "success_count": 2,
  "failed_count": 0,
  "results": [
    { "email": "user1@example.com", "success": true, "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "invitation_url": "https://..." },
    { "email": "user2@example.com", "success": true, "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012", "invitation_url": "https://..." }
  ]
}
```

**207 Multi-Status**（1人以上が失敗）

```json
{
  "total_count": 2,
  "success_count": 1,
  "failed_count": 1,
  "results": [
    { "email": "user1@example.com", "success": true, "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "invitation_url": "https://..." },
    { "email": "invalid-email", "success": false, "error_code": "invalid_email", "error": "invalid email format" }
  ]
}
```

#### レスポンスのフィールド

| フィールド           | 型         | 説明                |
| --------------- | --------- | ----------------- |
| `total_count`   | integer   | リクエストしたメールアドレスの件数 |
| `success_count` | integer   | 成功した件数            |
| `failed_count`  | integer   | 失敗した件数            |
| `results`       | object\[] | メールアドレスごとの結果（下表）  |

#### `results[]` のフィールド

リクエストのメールアドレス1件につき1要素が、リクエストと同じ順で返ります。レスポンスの `email` は小文字に変換されるため、`email` ではなく位置で対応付けてください。

| フィールド            | 型            | 説明                                                                                                                                                                                                                      |
| ---------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email`          | string       | リクエストのメールアドレスを、前後の空白を除いて小文字にしたもの。常に返ります。ただし、検証エラーの2つ（`empty_email` と `invalid_email`）では、リクエストの値がそのまま返ります                                                                                                                |
| `success`        | boolean      | このメールアドレスの処理に成功したかどうか                                                                                                                                                                                                   |
| `id`             | string（UUID） | プラットフォームのユーザー ID。成功した結果には必ず含まれます（新規作成、削除済みアカウントの復元、既存ユーザー、すでに組織のメンバーだった場合のいずれも）。そのため、[チームにユーザーを追加する](https://docs.digitalhumans.jp/itp-guide/api/team-members.md)などの後続の呼び出しに、別途検索せずに使えます。`success` が `false` のときは含まれません |
| `already_member` | boolean      | 呼び出し前からこの組織のメンバーだった場合に `true`。そうでない場合は含まれません。メンバーシップはそのままで、ロールだけが調整されます。招待は発行されません                                                                                                                                      |
| `invitation_url` | string       | Auth0 の招待リンク。招待が発行されなかった場合（`silent_add` のリクエスト、すでにメンバーだったユーザー）と、失敗した場合は含まれません                                                                                                                                           |
| `error_code`     | string       | 失敗の原因を示す、変わらない機械可読なコード。`success` が `false` のときだけ含まれます（下表）                                                                                                                                                               |
| `error`          | string       | 人が読むための失敗メッセージ。`success` が `false` のときだけ含まれます                                                                                                                                                                           |

分岐には、予告なく変わる可能性のある `error` の文言ではなく、`error_code` を使ってください。

{% hint style="info" %}
**ステータスコードだけでなく件数を確認してください。**\
`failed_count` が1以上なら、全件が失敗した場合も含めて、レスポンスは `207` になります。何が反映されたかは `success_count` と `failed_count` で判断してください。
{% endhint %}

#### ユーザーごとの `error_code`

ユーザーは1人ずつ別のデータベーストランザクションで処理されるため、1件の失敗が同じリクエスト内の他のメールアドレスに影響することはありません。「再試行」列は、同じリクエストを再試行してエラーが解消する見込みがあるかを示します。

**失敗したメールアドレスだけを再試行するのが最善です。** リクエストが小さくなり、無駄な処理を避けられます。ただし、成功済みのユーザーを含めて再試行しても**問題ありません**。既存ユーザーとして扱われ、組織のメンバーシップとロールが冪等に再適用されるだけで、再招待や招待メールの重複送信はありません。

| コード                           | 意味                                                                                                             | 再試行                                                                                                                                            |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `invalid_email`               | メールアドレスの形式が正しくない                                                                                               | **不可**。アドレスを直してから再試行してください                                                                                                                     |
| `empty_email`                 | 前後の空白を除くとメールアドレスが空                                                                                             | **不可**。空でない値を指定してください                                                                                                                          |
| `user_lookup_failed`          | ユーザーを検索できなかった                                                                                                  | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `user_create_failed`          | 新しいユーザーの作成、組織への追加、初期ロールの割り当てのいずれかに失敗した                                                                         | **可**。通常は一時的なエラーです。間隔を空けて再試行してください。失敗が続く場合は基盤側の問題のため、[弊社にお問い合わせください](https://www.digitalhumans.com/jp/contact)                                 |
| `org_membership_check_failed` | ユーザーがすでに組織に所属しているか確認できなかった                                                                                     | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `user_orgs_lookup_failed`     | ユーザーの既存の所属組織を取得できなかった                                                                                          | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `org_assignment_failed`       | ユーザーを組織に追加できなかった                                                                                               | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `user_resurrect_failed`       | 以前に削除したユーザーを再有効化できなかった                                                                                         | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `email_taken_by_live_user`    | 処理の途中で、有効なアカウントがこのアドレスを使い始めたため、削除済みアカウントをこのアドレスで復元することも、このアドレスで新規作成することもできなかった。同じアドレスへの同時書き込みが必要なため、まれにしか起きません | **そのままでは不可**。再試行すると成功と報告されますが、それは意図したアカウントの復元ではなく、現在このアドレスを持つ有効なアカウントを追加し、指定したロールを与えた結果です。先に重複を解消してください（別のアドレスを使う、または有効なアカウントが登録したい本人のものか確認する） |
| `invitation_url_store_failed` | 招待は生成されたが、招待 URL をユーザーの記録に保存できなかった                                                                             | **可**。再試行は安全です。新しい招待 URL が生成・保存されます。保存されなかった以前の招待は使われず、通常どおり期限切れになります                                                                          |
| `auth0_invite_failed`         | 上流の認証基盤（Auth0）の招待呼び出しに失敗した                                                                                     | **可**。通常は一時的なエラー（上流の障害やレート制限）です。間隔を空けて再試行してください。上流の呼び出しが一部成功していた場合、再試行でユーザーに招待メールが重複して届くことがあります                                                |
| `auth0_add_failed`            | 既存ユーザーを組織に追加する、上流の認証基盤（Auth0）の呼び出しに失敗した                                                                        | **可**。通常は一時的なエラー（上流の障害）です。間隔を空けて再試行してください                                                                                                      |
| `role_assignment_failed`      | 指定したロールを割り当てられなかった                                                                                             | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `transaction_start_failed`    | このユーザーの処理を開始できなかった（基盤が利用できない、または混雑している）                                                                        | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |
| `transaction_commit_failed`   | このユーザーの変更を保存できなかった。途中までの状態はロールバックされ、何も保存されません                                                                  | **可**。一時的なエラーです。間隔を空けて再試行してください                                                                                                                |

{% hint style="success" %}
**おすすめの再試行方法**\
再試行できるコードについては、リクエスト全体を指数バックオフ（例: 1秒、2秒、4秒…、上限 30 秒）で 3〜5 回まで再試行してください。`429` を受け取った場合は `Retry-After` ヘッダーに従ってください。何度か試しても同じコードが続く場合は、基盤側の障害として[弊社にお問い合わせください](https://www.digitalhumans.com/jp/contact)。
{% endhint %}

**400 Bad Request**（リクエスト全体の検証エラー）

```json
{
  "error_code": "emails_required",
  "message": "emails: at least one email is required"
}
```

リクエスト全体に対する `error_code` は次のとおりです: `invalid_request_body`、`validation_failed`、`emails_required`、`roles_required`、`invalid_role`。

| ステータス | 内容                             |
| ----- | ------------------------------ |
| `200` | 全員の追加に成功                       |
| `207` | 1人以上が失敗（部分的に成功）                |
| `400` | リクエスト全体の検証エラー（`error_code` 付き） |
| `401` | APIキーが無効                       |
| `429` | レート制限を超えた                      |

### 例

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X POST \
  "https://training.uneeq.io/api/external/v1/organization/{orgID}/users/add" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["newuser@example.com"],
    "roles": ["USER"]
  }'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

response = requests.post(
    f"{BASE_URL}/users/add",
    headers=headers,
    json={
        "emails": ["newuser@example.com"],
        "roles": ["USER"]
    }
)
print(response.json())
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const response = await fetch(`${BASE_URL}/users/add`, {
  method: 'POST',
  headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    emails: ['newuser@example.com'],
    roles: ['USER']
  })
});
const data = await response.json();
```

{% endtab %}
{% endtabs %}

***

## 組織のユーザーを一覧する <a href="#get-users-page-page" id="get-users-page-page"></a>

組織のユーザーをページ単位で取得します。

```
GET /users/page/{page}
```

### パスパラメーター

| パラメーター | 型       | 説明            |
| ------ | ------- | ------------- |
| `page` | integer | ページ番号（1から始まる） |

### クエリパラメーター

| パラメーター        | 型       | 説明                                                                              | 必須     |
| ------------- | ------- | ------------------------------------------------------------------------------- | ------ |
| `limit`       | integer | 1ページあたりの件数。`1`〜`100`                                                            | **はい** |
| `search`      | string  | 名前またはメールアドレスで検索                                                                 | いいえ    |
| `user_roles`  | string  | ロールで絞り込む（カンマ区切り。例: `USER,MANAGER`）                                              | いいえ    |
| `user_status` | string  | 状態で絞り込む（カンマ区切り）。値は `active`、`inactive`、`invited`、`expired`（例: `active,invited`） | いいえ    |

{% hint style="info" %}
**`limit` は必須です。**\
既定のページサイズはありません。毎回 `limit` を指定してください。省略した場合や、`1`〜`100` の範囲外の値を指定した場合は `400` が返ります。
{% endhint %}

### レスポンス

**200 OK**

```json
{
  "users": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "roles": ["MANAGER", "AUTHOR"],
      "organization_roles": null,
      "status": "active"
    }
  ],
  "records": 42
}
```

| フィールド                        | 型               | 説明                                            |
| ---------------------------- | --------------- | --------------------------------------------- |
| `users[].id`                 | string（UUID）    | ユーザー ID                                       |
| `users[].email`              | string          | メールアドレス                                       |
| `users[].name`               | string または null | 表示名。まだ名前を設定していないユーザーは `null`                  |
| `users[].roles`              | string\[]       | 割り当てられたロール                                    |
| `users[].organization_roles` | null            | このエンドポイントでは `null` が返ります。`roles` を読んでください     |
| `users[].status`             | string          | `active`、`inactive`、`invited`、`expired` のいずれか |
| `records`                    | integer         | 条件に一致したユーザーの総数                                |

ユーザーの状態の意味は次のとおりです。

| 値          | 意味            |
| ---------- | ------------- |
| `active`   | 有効            |
| `inactive` | 無効            |
| `invited`  | 招待をまだ受け入れていない |
| `expired`  | 招待の有効期限が切れている |

{% hint style="info" %}
**ロールは `roles` から読んでください。**\
このエンドポイントでは `organization_roles` は `null` で返ります。`roles` の値はすべて、リクエスト URL の組織に対するものなので、追加の検索は不要です。
{% endhint %}

| ステータス | 内容                 |
| ----- | ------------------ |
| `200` | 成功                 |
| `400` | `limit` が無い、または範囲外 |
| `401` | APIキーが無効           |
| `429` | レート制限を超えた          |

### 例

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET \
  "https://training.uneeq.io/api/external/v1/organization/{orgID}/users/page/1?limit=25&search=jane" \
  -H "Authorization: Bearer your-api-key"
```

{% endtab %}

{% tab title="Python" %}

```python
response = requests.get(
    f"{BASE_URL}/users/page/1",
    headers=headers,
    params={"limit": 25, "search": "jane"}
)
print(response.json())
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const response = await fetch(
  `${BASE_URL}/users/page/1?limit=25&search=jane`,
  { headers: { 'Authorization': `Bearer ${API_KEY}` } }
);
const data = await response.json();
```

{% endtab %}
{% endtabs %}

***

## ユーザーにロールを割り当てる <a href="#post-users-roles-assign" id="post-users-roles-assign"></a>

複数のユーザーに、1つ以上のロールを割り当てます。

```
POST /users/roles/assign
```

### リクエストボディ

```json
{
  "user_ids": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
  "roles": ["USER", "MANAGER"]
}
```

| フィールド      | 型               | 説明                                                             | 必須 |
| ---------- | --------------- | -------------------------------------------------------------- | -- |
| `user_ids` | string\[]（UUID） | ユーザー ID の一覧                                                    | はい |
| `roles`    | string\[]       | 割り当てるロール。値は `ORG_ADMIN`、`TEAM_ADMIN`、`AUTHOR`、`MANAGER`、`USER` | はい |

{% hint style="warning" %}
**`roles` は追加ではなく、まるごと置き換えです。**\
ユーザーのロールは、指定した内容とまったく同じになります。指定しなかった既存のロールは外れます。必ず、持たせたいロールをすべて指定してください。\
例: `USER` を持つユーザーに `MANAGER` を追加するには、`["USER", "MANAGER"]` を指定します。
{% endhint %}

{% hint style="info" %}
**`roles` に空の配列を指定すると、そのユーザーがこの組織で持つロールがすべて外れます。**\
その結果、`GET /users/page/{page}` の一覧にも表示されなくなります。持たせたいロールをすべて指定してください。
{% endhint %}

### レスポンス

| ステータス            | 内容          |
| ---------------- | ----------- |
| `204 No Content` | ロールの割り当てに成功 |
| `400`            | 不正なリクエスト    |
| `401`            | APIキーが無効    |
| `429`            | レート制限を超えた   |

### 例

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X POST \
  "https://training.uneeq.io/api/external/v1/organization/{orgID}/users/roles/assign" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "user_ids": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
    "roles": ["USER", "MANAGER"]
  }'
```

{% endtab %}

{% tab title="Python" %}

```python
response = requests.post(
    f"{BASE_URL}/users/roles/assign",
    headers=headers,
    json={
        "user_ids": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
        "roles": ["USER", "MANAGER"]
    }
)
# 204 = 成功
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
await fetch(`${BASE_URL}/users/roles/assign`, {
  method: 'POST',
  headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    user_ids: ['a1b2c3d4-e5f6-7890-abcd-ef1234567890'],
    roles: ['USER', 'MANAGER']
  })
});
```

{% endtab %}
{% endtabs %}

***

## ユーザーの状態を変更する <a href="#put-users-userid-status" id="put-users-userid-status"></a>

組織のユーザーを有効または無効にします。

```
PUT /users/{userID}/status
```

### パスパラメーター

| パラメーター   | 型            | 説明      |
| -------- | ------------ | ------- |
| `userID` | string（UUID） | ユーザー ID |

### リクエストボディ

```json
{
  "status": "active"
}
```

| フィールド    | 型      | 説明                      | 必須 |
| -------- | ------ | ----------------------- | -- |
| `status` | string | `active` または `inactive` | はい |

{% hint style="info" %}
**設定できるのは `active` と `inactive` だけです。**\
ユーザーの状態は `invited` や `expired` になることもありますが、この2つは招待の処理で設定される読み取り専用の値です。ここで指定すると `400` が返ります。
{% endhint %}

### レスポンス

| ステータス            | 内容                                        |
| ---------------- | ----------------------------------------- |
| `204 No Content` | 状態の変更に成功                                  |
| `400`            | 不正なリクエスト（`invited` や `expired` を指定した場合など） |
| `401`            | APIキーが無効                                  |
| `429`            | レート制限を超えた                                 |

### 例

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X PUT \
  "https://training.uneeq.io/api/external/v1/organization/{orgID}/users/{userID}/status" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"status": "inactive"}'
```

{% endtab %}

{% tab title="Python" %}

```python
response = requests.put(
    f"{BASE_URL}/users/{user_id}/status",
    headers=headers,
    json={"status": "inactive"}
)
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
await fetch(`${BASE_URL}/users/${userId}/status`, {
  method: 'PUT',
  headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ status: 'inactive' })
});
```

{% endtab %}
{% endtabs %}

***

## ユーザー情報を変更する <a href="#put-users-userid" id="put-users-userid"></a>

ユーザーのプロフィールを変更します。変更できるのは `name`、`email`、`locale`、`user_theme` です。外部 API からパスワードは変更できません。

```
PUT /users/{userID}
```

{% hint style="warning" %}
**メールアドレスの変更とシングルサインオン（SSO）**\
メールアドレスを変更すると、プラットフォーム上のユーザーの識別情報が変わります。SSO でサインインするユーザーの場合、新しいメールアドレスは、次回サインイン時に ID プロバイダー（IdP）が送るメールアドレスのクレームと一致している必要があります。一致しないとサインインできなくなります。\
この項目は、IdP の移行（IdP が既存ユーザーに新しいメールアドレスを割り当てる場合など）に対応するためのものです。SSO については「[シングルサインオン（SSO）](https://docs.digitalhumans.jp/itp-guide/initial-setup/sso.md)」をご覧ください。
{% endhint %}

### パスパラメーター

| パラメーター   | 型            | 説明      |
| -------- | ------------ | ------- |
| `userID` | string（UUID） | ユーザー ID |

### リクエストボディ

少なくとも1つのフィールドを指定してください。

```json
{
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "locale": "en-US",
  "user_theme": "dark"
}
```

| フィールド        | 型             | 説明                                                                         | 必須  |
| ------------ | ------------- | -------------------------------------------------------------------------- | --- |
| `name`       | string        | 表示名（最大 250 文字）                                                             | いいえ |
| `email`      | string（email） | 新しいメールアドレス。正しい形式で、他の有効なアカウントで使われていないものに限ります。削除したユーザーのアドレスは、別のユーザーに割り当て直せます | いいえ |
| `locale`     | string        | 言語のロケール（例: `en-US`。最大 10 文字）。対応しているロケールに限ります                               | いいえ |
| `user_theme` | string        | 画面のテーマ。`light`、`dark`、`system` のいずれか                                       | いいえ |

{% hint style="info" %}
日本語のロケールを指定する場合は `ja-JP` を使ってください（`ja` はエラーになります）。
{% endhint %}

### レスポンス

**204 No Content**: ユーザー情報の変更に成功しました。

### エラー

| コード   | 説明                                                                                                                                                                                                                                                         |
| ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `400` | 不正なリクエスト、メールアドレスの形式が正しくない、対応していないロケール、またはフィールドが1つも指定されていない                                                                                                                                                                                                 |
| `401` | APIキーが無効、または指定されていない                                                                                                                                                                                                                                       |
| `404` | 組織にユーザーが見つからない                                                                                                                                                                                                                                             |
| `405` | このユーザーは更新できない。APIキーが、対象の組織でユーザーを更新できるロールを持っていない場合に返ります（例: キーが別の組織のものである、キーにひも付くロールが取り消されている）。これは権限の判定であり、一時的な失敗ではないため、再試行しても解決しません。APIキーが正しい組織のもので、必要な権限を持っているか確認してください                                                                                    |
| `409` | メールアドレスが有効なアカウントで使用中。メッセージで使用元を区別できます。同じ組織内のユーザーが使っている場合は `email is already in use by another user`、組織外の有効なアカウントが使っている場合は `email is already in use by an active account outside this organization` です。メールアドレスを保持できるのは有効なアカウントだけで、削除したユーザーの以前のアドレスは割り当て直せます |
| `429` | レート制限を超えた                                                                                                                                                                                                                                                  |

### 例

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X PUT \
  "https://training.uneeq.io/api/external/v1/organization/{orgID}/users/{userID}" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Jane Doe", "email": "jane.doe@example.com", "locale": "en-US", "user_theme": "dark"}'
```

{% endtab %}

{% tab title="Python" %}

```python
response = requests.put(
    f"{BASE_URL}/users/{user_id}",
    headers=headers,
    json={
        "name": "Jane Doe",
        "email": "jane.doe@example.com",
        "locale": "en-US",
        "user_theme": "dark"
    }
)
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
await fetch(`${BASE_URL}/users/${userId}`, {
  method: 'PUT',
  headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: 'Jane Doe',
    email: 'jane.doe@example.com',
    locale: 'en-US',
    user_theme: 'dark'
  })
});
```

{% endtab %}
{% endtabs %}
