Skip to main content
PUT
/
users
/
{user_id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "display_name": "<string>",
  "icon_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
X-Rheel-API-Key
string
header
required

管理系API呼び出し用のAPIキーを指定します

Path Parameters

​
user_id
string
required
Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json
​
display_name
string
required

ユーザーの表示名

Required string length: 1 - 200
​
role
enum<string>
required

ユーザーの権限・役割(admin:管理者, member:一般ユーザー)

Available options:
Admin,
Member
​
icon_url
string | null

ユーザーアイコンのURL

​
metadata
object

任意の追加メタデータ

Response

ユーザーの更新完了

​
id
string
required

ユーザーの一意な識別子（ユーザー作成時に任意のidを指定できます）

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$
​
display_name
string
required

ユーザーの表示名

Required string length: 1 - 200
​
role
enum<string>
required

ユーザーの権限・役割(Admin:管理者, Member:一般ユーザー)

Available options:
Admin,
Member
​
icon_url
string | null

ユーザーアイコンのURL

​
created_at
string<date-time>
read-only

作成日時

​
updated_at
string<date-time> | null
read-only

更新日時

​
deleted_at
string<date-time> | null
read-only

削除日時

​
metadata
object

任意の追加メタデータ